How do you start your own instance of docs for Rails and other Gems you have installed?

To view docs for all Gems installed

It’s assumed that you already have RubyGems installed.

The following will provide you API docs for all of the gems you’ve installed on your computer.
Each gem listed will have a description, its dependencies, URL to APIs docs and URL to its corresponding web page.

gem server

Point your browser to http://localhost:8808

How to generate Rails docs after freezing gems into your rails app

cd your_rails_app

rake rails:freeze:gems

rake docs:rails

The above will generate documentation and place it in your_rails_app/doc/api directory

VN:F [1.9.22_1171]
Rating: 0.0/5 (0 votes cast)
VN:F [1.9.22_1171]
Rating: 0 (from 0 votes)
Facebook Twitter Email

Leave a Reply