Skip to content

Commit

Permalink
Switching to Yardoc by default for documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bob Aman committed Aug 10, 2010
1 parent da4bb1f commit 6c052b8
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
3 changes: 0 additions & 3 deletions tasks/rdoc.rake
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,4 @@ namespace :doc do
end
end

desc "Alias to doc:rdoc"
task "doc" => "doc:rdoc"

task "clobber" => ["doc:clobber_rdoc", "doc:clobber_ri"]
2 changes: 1 addition & 1 deletion tasks/rubyforge.rake
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ end

namespace :doc do
desc "Publish RDoc to RubyForge"
task :release => ["doc:rdoc"] do
task :release => ["doc"] do
require "rake/contrib/sshpublisher"
require "yaml"

Expand Down
26 changes: 26 additions & 0 deletions tasks/yard.rake
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
require "rake"

begin
require "yard"
require "yard/rake/yardoc_task"

namespace :doc do
desc "Generate Yardoc documentation"
YARD::Rake::YardocTask.new do |yardoc|
yardoc.name = "yard"
yardoc.options = ["--verbose"]
yardoc.files = [
"lib/**/*.rb", "ext/**/*.c", "README", "CHANGELOG", "LICENSE"
]
end
end

task "clobber" => ["doc:clobber_yard"]

desc "Alias to doc:yard"
task "doc" => "doc:yard"
rescue LoadError
# If yard isn't available, it's not the end of the world
desc "Alias to doc:rdoc"
task "doc" => "doc:rdoc"
end

0 comments on commit 6c052b8

Please sign in to comment.