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 require 'rake/clean'
  10
  11 CLOBBER.include('doc', 'ri')
  12 CLOBBER.uniq!
  13
  14 namespace :doc do
  15   desc 'Generate RDoc documentation'
  16   RDoc::Task.new do |rdoc|
  17     rdoc.rdoc_dir = 'doc'
  18     rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
  19     rdoc.options << '--line-numbers' << 'cattr_accessor=object' <<
  20       '--charset' << 'utf-8'
  21     rdoc.template = "#{ENV['template']}.rb" if ENV['template']
  22     rdoc.rdoc_files.include('README.md', 'CHANGELOG.md', 'LICENSE')
  23     rdoc.rdoc_files.include('lib/**/*.rb')
  24   end
  25
  26   desc 'Generate ri locally for testing'
  27   task :ri do
  28     sh 'rdoc --ri -o ri .'
  29   end
  30 end