Using custom RDoc templates in Ruby gems

I think that the default RDoc template looks horrible. The colors are not good at all, and the top frames waste a lot of space. On the other hand, the Jamis RDoc template looks a lot better.

Today I ran into a problem: RubyGems can generate RDoc documentation for projects, but how do I force it to use the right template? The Jamis template installation instructions don’t work with the Rake RubyGems task. Eventually I found out that I had to do this:

Rake::RDocTask.new do |rd|
	...
	rd.template = "./doc/template/jamis"
	...
end

And put ‘jamis.rb’ into the folder ./doc/template/

1 Comment »

  1. Daniel Lv said,

    March 25, 2008 @ 1:29 pm

    Excellent, But i just wander where i can put those code into?
    I wanner convert all rubygem’s rdoc to Jamis style, please help…

RSS feed for comments on this post · TrackBack URI

Leave a Comment