The Artima Developer Community
Sponsored Link

Ruby Buzz Forum
Got Rdoc?

0 replies on 1 page.

Welcome Guest
  Sign In

Go back to the topic listing  Back to Topic List Click to reply to this topic  Reply to this Topic Click to search messages in this forum  Search Forum Click for a threaded view of the topic  Threaded View   
Previous Topic   Next Topic
Flat View: This topic has 0 replies on 1 page
Jared Richardson

Posts: 1031
Nickname: jaredr
Registered: Jun, 2005

Jared Richardson is an author, speaker, and consultant who enjoys working with Ruby and Rails.
Got Rdoc? Posted: May 25, 2007 8:18 AM
Reply to this message Reply

This post originated from an RSS feed registered with Ruby Buzz by Jared Richardson.
Original Post: Got Rdoc?
Feed Title: Agile Artisans
Feed URL: http://agileartisans.com/main/rss
Feed Description: Jared's Blog
Latest Ruby Buzz Posts
Latest Ruby Buzz Posts by Jared Richardson
Latest Posts From Agile Artisans

Advertisement
I'm always hearing people say that they want to have local docs like the ones at the Ruby Rdoc page. I've also wanted this and looked all over for a way to download these docs and haven't found them. Everyone says "Use Rdoc" but nothing more. I've only used rdoc on my own project and just didn't get what they were suggesting.

With Rdoc, it takes a few minutes to generate them, but you can make your own local copy of any Ruby docs. I think 90% of the Ruby/Rails world knows this already, but those of weren't in the secret, try this.

cd into your local directory that holds your Ruby/Rails code. This could be your own project code, /usr/local/lib/ruby/gems/1.8/gems/activerecord-1.15.3 (to generate your Active Record docs), or /usr/local/lib/ruby/1.8 (to build your own core Ruby docs). Since Ruby is interpreted, you've got all the system code right there on your own box.

Create a directory in your home folder called rdoc (or whatever you

Read: Got Rdoc?

Topic: Hug Your Designer Day, part 2 Previous Topic   Next Topic Topic: stylesheet_include

Sponsored Links



Google
  Web Artima.com   

Copyright © 1996-2019 Artima, Inc. All Rights Reserved. - Privacy Policy - Terms of Use