Yard documentation rake task and gitignoring output.
This commit is contained in:
parent
35af1fa02b
commit
025cede012
|
@ -7,3 +7,5 @@ cookbooks/*
|
|||
_site/*
|
||||
!templates/*
|
||||
*.org
|
||||
.yardoc/
|
||||
doc/
|
11
Rakefile
11
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
|
Loading…
Reference in New Issue