Contents

desc "Generate RDoc"
task :doc => ['doc:generate']

namespace :doc do
  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
  doc_destination = File.join(project_root, 'rdoc')

  begin
    require 'yard'
    require 'yard/rake/yardoc_task'

    YARD::Rake::YardocTask.new(:generate) do |yt|
      yt.files = Dir.glob(File.join(project_root, 'lib', '*.rb')) +
                 Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + ['-'] +
                [ File.join(project_root, 'README.md') ] +
                [ File.join(project_root, 'LICENSE') ]

      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
    end
  rescue LoadError
    desc "Generate YARD Documentation"
    task :generate do
      abort "Please install the YARD gem to generate rdoc."
    end
  end

  desc "Remove generated documenation"
  task :clean do
    rm_r doc_destination if File.exists?(doc_destination)
  end

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
dor-services-5.2.0	lib/tasks/rdoc.rake