Get Your Rails Docs Locally For Your RailsConf Trip

Ok, its almost time for RailsConf. We're all packing up our goodies, and maybe cleaning up our apps to show off.

But what about doing a little coding on the plane? OMG, what if we need docs!!

Have no fear, heres how to generate your docs, to have locally.

rails fake_app
cd fake_app
rake rails:freeze:gems
rake doc:rails

Boom, there you go. Take a look in ./fake_app/docs/api and you'll see all the docs. Now your Rails docs are available locally to peruse while on the plane.

What about our Ruby docs? Just go to your Ruby library and generate the rdocs there.

cd /usr/local/lib/ruby/1.8
sudo rdoc
cp -r doc/ ~/Desktop

Nice... now you're ready to get coding on the plane over to Portland. Or on your way home, after you've been energized.

  • these instructions assume Mac Os X. From what I saw last year, a safe assumption.

Popularity: 4% [?]

You can skip to the end and leave a response. Pinging is currently not allowed.

2 Thoughts

  1. There is another easy way you can do it if you don't mind looking at the documentation for the Rails components separately: http://www.dcmanges.com/blog/31

    It's also good if you're offline and didn't do the steps above.

  2. ha,thanks dan. gem_server is something i left off...

Share Your Thoughts?

Please excuse my captcha. But the internets require it these days. Comment triage isn’t billable.