diff options
author | Lamont Granquist <lamont@scriptkiddie.org> | 2013-06-20 12:52:30 -0700 |
---|---|---|
committer | Lamont Granquist <lamont@scriptkiddie.org> | 2013-06-20 16:38:02 -0700 |
commit | 06627ab9f9a08420822eb908cb4c60342a298878 (patch) | |
tree | 87eae11899a8df907dab36fabd0af68c66b5239f | |
parent | 25dbcb9a37a82bdd732b6ed4c50a8a4ba906b087 (diff) | |
download | chef-06627ab9f9a08420822eb908cb4c60342a298878.tar.gz |
add rake task for generating docs with YARD
-rw-r--r-- | Gemfile | 1 | ||||
-rw-r--r-- | Rakefile | 15 |
2 files changed, 16 insertions, 0 deletions
@@ -6,6 +6,7 @@ gem "activesupport", :group => :compat_testing, :platform => "ruby" group(:docgen) do gem "ronn" + gem "yard" end group(:development, :test) do @@ -118,5 +118,20 @@ end task :docs => "docs:all" +begin + require 'yard' + DOC_FILES = [ "README.rdoc", "LICENSE", "spec/tiny_server.rb", "lib/**/*.rb" ] + namespace :yard do + desc "Create YARD documentation" + + YARD::Rake::YardocTask.new(:html) do |t| + t.files = DOC_FILES + t.options = ['--format', 'html'] + end + end + +rescue LoadError + puts "yard is not available. (sudo) gem install yard to generate yard documentation." +end |