Posted by Jamis on April 08, 2005 @ 02:45 AM
Gavin Sinclair, after googling to no avail, encouraged me to post the URL for my “jamis” RDoc template so that others might be able to find it more easily.
This is the same template (well, a newer version of the same template) that I use for the API documentation of SQLite/Ruby, SQLite3/Ruby, Needle, Copland, Net::SSH, and Net::SFTP. Jim Weirich has also used it for his Rake API docs, and David Heinemeier Hansson is using it for the Rails API docs.
So, with that kind of recommendation, how can you possibly resist? Download it at:
To use it, copy it into the “rdoc/generators/template/html” directory of your Ruby installation (i.e., on my machine, ”/usr/local/lib/ruby/1.8/rdoc/generators/template/html”). Then, when you run rdoc, just pass “—template=jamis” and you should be good to go.