Resolved deprecation issues with RDoc task.
[arvados.git] / tasks / rdoc.rake
index 1f636c9691cf74c57bf122076ea1c50cb46c7a77..ef3e008031e1fc974e74e4f675d93516672a1052 100644 (file)
@@ -1,29 +1,33 @@
-require "rake/rdoctask"
+require 'rubygems'
+begin
+  # We prefer to use the RDoc gem over the site version.
+  gem 'rdoc'
+rescue Gem::LoadError
+end unless defined?(RDoc)
+
+require 'rdoc/task'
 
 namespace :doc do
-  desc "Generate RDoc documentation"
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = "doc"
+  desc 'Generate RDoc documentation'
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
     rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
-    rdoc.options << "--line-numbers" << "--inline-source" <<
-      "--accessor" << "cattr_accessor=object" << "--charset" << "utf-8"
-    rdoc.template = "#{ENV["template"]}.rb" if ENV["template"]
-    rdoc.rdoc_files.include("README", "CHANGELOG", "LICENSE")
-    rdoc.rdoc_files.include("lib/**/*.rb")
+    rdoc.options << '--line-numbers' << 'cattr_accessor=object' <<
+      '--charset' << 'utf-8'
+    rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+    rdoc.rdoc_files.include('README.md', 'CHANGELOG', 'LICENSE')
+    rdoc.rdoc_files.include('lib/**/*.rb')
   end
 
-  desc "Generate ri locally for testing"
+  desc 'Generate ri locally for testing'
   task :ri do
-    sh "rdoc --ri -o ri ."
+    sh 'rdoc --ri -o ri .'
   end
 
-  desc "Remove ri products"
+  desc 'Remove ri products'
   task :clobber_ri do
-    rm_r "ri" rescue nil
+    rm_r 'ri' rescue nil
   end
 end
 
-desc "Alias to doc:rdoc"
-task "doc" => "doc:rdoc"
-
-task "clobber" => ["doc:clobber_rdoc", "doc:clobber_ri"]
+task 'clobber' => ['doc:clobber_rdoc', 'doc:clobber_ri']