The maze book for programmers!
PragProg Amazon

Algorithms, circle mazes, hex grids, masking, weaving, braiding, 3D and 4D grids, spheres, and more!

DRM-Free Ebook

The Buckblog

assorted ramblings by Jamis Buck

RDoc Template

8 April 2005 — 1-minute read

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.

Reader Comments

AWESOME. I have been looking around for this forever. Its 1000 times better than the default template. It should seriously be included out of the box w/ rdoc.

I recently tweaked your Jamis rdoc template to use a two frame system and the simplest dhtml. The left frame displays only one of the three indexes at a time, but has a <select> to switch around. It also has a quick-search function that uses regexp matching on link titles to toggle link visibility.

Currently I don’t have a good place to make the template available. Anyone interested is welcome to contact me.

thanks a lot for the template. i’ve also been looking for it for a while.