tasks/rdoc.rake

   1 require 'rake/rdoctask'
   2
   3 namespace :doc do
   4   desc 'Generate RDoc documentation'
   5   Rake::RDocTask.new do |rdoc|
   6     rdoc.rdoc_dir = 'doc'
   7     rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
   8     rdoc.options << '--line-numbers' << '--inline-source' <<
   9       '--accessor' << 'cattr_accessor=object' << '--charset' << 'utf-8'
  10     rdoc.template = "#{ENV['template']}.rb" if ENV['template']
  11     rdoc.rdoc_files.include('README', 'CHANGELOG', 'LICENSE')
  12     rdoc.rdoc_files.include('lib/**/*.rb')
  13   end
  14
  15   desc 'Generate ri locally for testing'
  16   task :ri do
  17     sh 'rdoc --ri -o ri .'
  18   end
  19
  20   desc 'Remove ri products'
  21   task :clobber_ri do
  22     rm_r 'ri' rescue nil
  23   end
  24 end
  25
  26 task 'clobber' => ['doc:clobber_rdoc', 'doc:clobber_ri']