Generate an HTML index of your ruby gem rdocs

Tagged:  •  

Rubygems is kind enough to generate RDoc for installed gems, but the directories move as the gem versions evolve, and it's inconvenient to keep browsing for them. This tool produces a useful HTML index with direct links to the RDocs for all the gems installed on your system.

Example Gem RDoc index page

Getting it

The program's git repository is here: gemdocindex.

Either browse to 'gemdocindex' there and download the raw version, or check out ("clone") the repository as follows:
git clone git://git.sanityinc.com/gemdocindex.git
You can then track future changes by executing this command in the 'gemdocindex' directory:
git pull

Running it

Execute this command from a UNIX command line:
./gemrdoc > gemindex.html
(Windows users can probably run the same command, but adding "ruby" at the beginning.)

Tested on OS X; should work on other platforms. Patches are welcome.

Further information

If you found this helpful, you can subscribe to get more articles about Rails and Ruby-related topics and tools.

Syndicate content