Add the yard rake task for generating internal API documentation

This commit is contained in:
R. Tyler Croy 2014-07-06 14:05:32 -07:00
parent d618517729
commit a4cd46aa37
6 changed files with 12 additions and 0 deletions

2
.gitignore vendored
View File

@ -2,3 +2,5 @@
pkg/
.ruby-*
.vagrant*
doc/
.yardoc/

View File

@ -18,4 +18,6 @@ group :test do
gem 'rspec'
# For creating the executable package
gem 'warbler'
gem 'yard'
end

View File

@ -61,6 +61,7 @@ GEM
jruby-rack (>= 1.0.0)
rake (>= 0.9.6)
rubyzip (>= 0.9, < 1.1)
yard (0.8.7.3)
PLATFORMS
java
@ -75,3 +76,4 @@ DEPENDENCIES
rake
rspec
warbler
yard

View File

View File

6
tasks/yard.rake Normal file
View File

@ -0,0 +1,6 @@
require 'yard'
require 'yard/rake/yardoc_task'
YARD::Rake::YardocTask.new do |t|
t.files = ['lib/**/*.rb', '-', 'README.md', 'docs/**/*.md']
end