diff --git a/.gitignore b/.gitignore index 36d08933e..935e70502 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,5 @@ cookbooks/* _site/* !templates/* *.org +.yardoc/ +doc/ \ No newline at end of file diff --git a/Rakefile b/Rakefile index c5c664a02..f46a146fd 100644 --- a/Rakefile +++ b/Rakefile @@ -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 \ No newline at end of file