tasks/rdoc.rake

   1 require 'rubygems'
   2 begin
   3   # We prefer to use the RDoc gem over the site version.
   4   gem 'rdoc'
   5 rescue Gem::LoadError
   6 end unless defined?(RDoc)
   7
   8 require 'rdoc/task'
   9
  10 namespace :doc do
  11   desc 'Generate RDoc documentation'
  12   RDoc::Task.new do |rdoc|
  13     rdoc.rdoc_dir = 'doc'
  14     rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
  15     rdoc.options << '--line-numbers' << 'cattr_accessor=object' <<
  16       '--charset' << 'utf-8'
  17     rdoc.template = "#{ENV['template']}.rb" if ENV['template']
  18     rdoc.rdoc_files.include('README.md', 'CHANGELOG', 'LICENSE')
  19     rdoc.rdoc_files.include('lib/**/*.rb')
  20   end
  21
  22   desc 'Generate ri locally for testing'
  23   task :ri do
  24     sh 'rdoc --ri -o ri .'
  25   end
  26
  27   desc 'Remove ri products'
  28   task :clobber_ri do
  29     rm_r 'ri' rescue nil
  30   end
  31 end
  32
  33 task 'clobber' => ['doc:clobber_rdoc', 'doc:clobber_ri']