Yard documentation rake task and gitignoring output.

This commit is contained in:
Mitchell Hashimoto 2010-03-03 23:14:06 -08:00
parent 35af1fa02b
commit 025cede012
2 changed files with 13 additions and 0 deletions

2
.gitignore vendored
View File

@ -7,3 +7,5 @@ cookbooks/*
_site/*
!templates/*
*.org
.yardoc/
doc/

View File

@ -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