tasks/yard.rake

   1 require 'rake'
   2
   3 begin
   4   require 'yard'
   5   require 'yard/rake/yardoc_task'
   6
   7   namespace :doc do
   8     desc 'Generate Yardoc documentation'
   9     YARD::Rake::YardocTask.new do |yardoc|
  10       yardoc.name = 'yard'
  11       yardoc.options = ['--verbose']
  12       yardoc.files = [
  13         'lib/**/*.rb', 'ext/**/*.c', 'README', 'CHANGELOG', 'LICENSE'
  14       ]
  15     end
  16   end
  17
  18   task 'clobber' => ['doc:clobber_yard']
  19
  20   desc 'Alias to doc:yard'
  21   task 'doc' => 'doc:yard'
  22 rescue LoadError
  23   # If yard isn't available, it's not the end of the world
  24   desc 'Alias to doc:rdoc'
  25   task 'doc' => 'doc:rdoc'
  26 end