diff options
author | James Turnbull <james@lovedthanlost.net> | 2010-04-12 22:44:35 +1000 |
---|---|---|
committer | James Turnbull <james@lovedthanlost.net> | 2010-04-12 22:44:35 +1000 |
commit | 3ee6834a81b1a997a426fe086e1d98d03f8d8b2d (patch) | |
tree | 8ac50342242d72bffea9943223bf5bd1f3d356ad | |
parent | 99818ef5a00cdce50390d229f21ebd22b81eba00 (diff) | |
download | puppet-3ee6834a81b1a997a426fe086e1d98d03f8d8b2d.tar.gz puppet-3ee6834a81b1a997a426fe086e1d98d03f8d8b2d.tar.xz puppet-3ee6834a81b1a997a426fe086e1d98d03f8d8b2d.zip |
Added YARD task
You need to:
gem install yard
Then run:
rake yard
This will generate a "doc" directory containing YARD documentation.
-rw-r--r-- | tasks/rake/yard.rake | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/tasks/rake/yard.rake b/tasks/rake/yard.rake new file mode 100644 index 000000000..4fc3f7c97 --- /dev/null +++ b/tasks/rake/yard.rake @@ -0,0 +1,11 @@ +begin + require 'yard' + + YARD::Rake::YardocTask.new do |t| + t.files = ['lib/**/*.rb', 'spec/**/*.rb'] + end + +rescue LoadError + # yard not installed (gem install yard) + # # http://yardoc.org +end |