Offline rdoc gem documentation in Ruby

I always forget how to do this one, even though it’s really simple. (Make sure that you have rdoc installed first) To view all the API documentation in gems, simple run:

gem_server
gem server

from the command prompt. It will start a WEBrick server up on your local machine on port 8808. Therefore, if you browse to http://localhost:8808/, you’ll see a list of documentation of the gems on your machine.

Updated:
It’s incorporated into the gem command now, so just do “gem server”

Advertisements

3 thoughts on “Offline rdoc gem documentation in Ruby

  1. i was looking for this for quite some time. I figured something like this should exist, because when you install a gem it says installing rdoc. Great stuff!

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