tasks/yard.rake

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