From 2f70ebb1c50fb8876745dd5ceefe272607cc9698 Mon Sep 17 00:00:00 2001 From: Matthias H Date: Mon, 9 Mar 2015 05:00:59 +0100 Subject: rake: yarn doc task --- tasks/doc.rake | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 tasks/doc.rake (limited to 'tasks') diff --git a/tasks/doc.rake b/tasks/doc.rake new file mode 100644 index 00000000..b39f8c65 --- /dev/null +++ b/tasks/doc.rake @@ -0,0 +1,31 @@ +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, 'doc') + + 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')) +# + +# [ File.join(project_root, 'README.md') ] + 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_dir if File.exists?(doc_destination) + end + +end + -- cgit v1.2.3