RDoctor provides quick and convenient access to the documentation for all of the RubyGems installed on your local machine. It is essentially a simple, single-purpose web browser specifically designed to browse local rdocs.

At startup, RDoctor starts "gem server" for you in the background and navigates to a page that shows a list of all of your installed RubyGems, with links to the rdocs and web site for each. You can move forward and backward through pages just like you would with a standard browser. (If you prefer, you can even open the page you are currently viewing in your default web browser.)

You can also use RDoctor to generate documentation for plugins that are part of your Ruby on Rails projects. Simply select ‘Generate RDocs for Plugins…” and navigate to your Rails project in the Finder.

After a few seconds, you can access the newly generated Rdocs for each plugin.

RDoctor - RDoctor provides quick and convenient access to the documentation for all of the RubyGems installed on your local machine.
RDoctor provides quick and convenient access to the documentation for all of the RubyGems installed on your local machine.



Installation

RDoctor is a free tool offered as a service to the Ruby and Rails communities.

To get started:

That's it! Now you can create and browse your documentation in style.

rdoctor_screen_shot.png

Troubleshooting

If RDoctor starts up with a blank screen, wait a few seconds and then click on the Home icon. This issue will be addressed in a new release in the next couple of days. Thanks to Brad at condense for the bug report.


License and Legal Stuff

CC-GNU GPL

This software is licensed under the CC-GNU GPL version 2.0 or later.


Back to Projects