Project #2 – How to make Your Own Rails API Documentation and reading it offline

You can create your own local version of the consolidated Rails API documentation.

Just type the following commands at a command prompt:


<code>$ rails new dummy_app
$ cd dummy_app
$ dummy_app> rake doc:rails
</code>

 

 

The last step takes a while. When it finishes, you’ll have the Rails API documentation in a directory tree starting at doc/api. We suggest moving this folder to your desktop and then deleting the dummy_app tree. To view the Rails API documentation, open the location doc/api/index.html with your browser.
Advertisements

Leave a Reply

Please log in using one of these methods to post your comment:

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