diff options
author | James Turnbull <james@lovedthanlost.net> | 2010-04-12 22:44:35 +1000 |
---|---|---|
committer | test branch <puppet-dev@googlegroups.com> | 2010-02-17 06:50:53 -0800 |
commit | 0f077c78922994e74025c207436b3fb1d32c4249 (patch) | |
tree | bc3ee36d8ebc3b9fdbec3eb80501419947183dc2 | |
parent | b49c60bd35aa216197c330934ccb0cc69982bad9 (diff) | |
download | puppet-0f077c78922994e74025c207436b3fb1d32c4249.tar.gz puppet-0f077c78922994e74025c207436b3fb1d32c4249.tar.xz puppet-0f077c78922994e74025c207436b3fb1d32c4249.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 |