Skip to content

Commit

Permalink
Use YARD to generate docs
Browse files Browse the repository at this point in the history
Run "rake yard" to generate the docs locally.
  • Loading branch information
dasch authored and thumblemonks committed Jan 15, 2010
1 parent 731b11c commit f64737f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .gitignore
@@ -1,3 +1,5 @@
*.gem
pkg
.*.swp
.*.swp
doc
.yardoc
10 changes: 10 additions & 0 deletions Rakefile
Expand Up @@ -11,6 +11,16 @@ Rake::TestTask.new(:test) do |test|
test.verbose = false
end

begin
require 'yard'
require 'yard/rake/yardoc_task'
YARD::Rake::YardocTask.new do |t|
t.files = ['lib/**/*.rb']
end
rescue LoadError
# YARD isn't installed
end

desc "Run all of them fancy benchmarks, Howard!"
task :benchmarks do
Dir["test/benchmark/*.rb"].each do |file|
Expand Down

0 comments on commit f64737f

Please sign in to comment.