Skip to content

Ruby Documentation

Ruby documentation can be found in the following places :


RDoc produces HTML and online documentation for Ruby projects. We can use the command line tool rdoc to generate Ruby documentation.

RVM Documentation

rvm docs generate

ri documentation from rvm

Generate ri docs without generating rdoc with the following :

rvm docs generate-ri


The ri command line tool will show Ruby documentation if installed. To show ri documentation for the String, you can run the following on the terminal :

ri String

Ruby Gems Documentation

You can find documentation on installed gems by running the gems server as follows :

gem server

You will get a port number on which the gem server is running. Use the browser to access the server.