Nov 13

Creating docs for Rails, Rails Edge, Plugins

If you are using Rails and want to access docs locally, you can do it with typing gem_server in command prompt. Documentation for Rails and other installed gems would be available at http://localhost:8808.

For those working on latest Rails, you can create documentation from project path with these Rake task:

rake doc:rails

And creating docs for installed Rails plugins is easy as well:

rake doc:plugins

If you are unfortunate to tun latest task on windows machine, you would soon realize it doesn’t work. Until fixed, you can hack it work by changing line 78 of source file in lib/tasks/documentation.rake to:

sh %(rdoc.bat #{options * ’ ‘})