tasks/doc.rake

   1 desc "Generate RDoc"
   2 task :doc => ['doc:generate']
   3
   4 namespace :doc do
   5   project_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
   6   doc_destination = File.join(project_root, 'doc')
   7
   8   begin
   9     require 'yard'
  10     require 'yard/rake/yardoc_task'
  11
  12     YARD::Rake::YardocTask.new(:generate) do |yt|
  13       yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb'))
  14 # +
  15 #                   [ File.join(project_root, 'README.md') ]
  16       yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
  17     end
  18   rescue LoadError
  19     desc "Generate YARD Documentation"
  20     task :generate do
  21       abort "Please install the YARD gem to generate rdoc."
  22     end
  23   end
  24
  25   desc "Remove generated documenation"
  26   task :clean do
  27     rm_r doc_dir if File.exists?(doc_destination)
  28   end
  29
  30 end
  31