Permalink
Browse files

Yard documentation rake task and gitignoring output.

  • Loading branch information...
1 parent 35af1fa commit 025cede0126d1d6414fc09b7d80619a016c750d3 @mitchellh mitchellh committed Mar 4, 2010
Showing with 13 additions and 0 deletions.
  1. +2 −0 .gitignore
  2. +11 −0 Rakefile
View
@@ -7,3 +7,5 @@ cookbooks/*
_site/*
!templates/*
*.org
+.yardoc/
+doc/
View
@@ -28,3 +28,14 @@ Rake::TestTask.new do |t|
t.libs << "test"
t.pattern = 'test/**/*_test.rb'
end
+
+begin
+ require 'yard'
+ YARD::Rake::YardocTask.new do |t|
+ t.options = ['--main', 'README.md', '--markup', 'markdown']
+ t.options += ['--title', 'Vagrant Developer Documentation']
+ end
+rescue LoadError
+ puts "Yard not available. Install it with: gem install yard"
+ puts "if you wish to be able to generate developer documentation."
+end

0 comments on commit 025cede

Please sign in to comment.