Pretty rdocs for local gems

Bdoc gem provides a nice interface to move between different gems. To view rdocs for installed gems


gem install manalang-bdoc
bdoc

the second step will open a browser window to view rdocs for them.

This will show the docs for all version of the gem installed.

To make it look a bit prettier and do some gotapi kind of ajaxy stuff then install the hanna rdoc template gem.
Note: Just so you know gotapi doesn’t work at all if you have javascript turned off.
gem install mislav-hanna
open ~/.gemrc and add

:rdoc: --inline-source --line-numbers --format=html --template=hanna

rebuild all your gems

gem rdoc --all --no-ri
That will take sometime depending upon the number of gems are installed locally on the machine. Once all the gems are rebuilt, then run
bdoc
on command line to view rdoc using new templates.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s