# RI documentation for RubyGems **URL:** \ **Category:** Ruby\ **Created:** [April 18, 2006, 10:12pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038 "2006-04-18T22:12:42Z")\ **Posts on this page:** 7\ **Page:** 1
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 18, 2006, 10:12pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/1 "2006-04-18T22:12:42Z")
Can anyone explain how the RI documentation for RubyGems may be: 1. generated 2. subsequently accessed via RI? Any info. is appreciated - my research tells me that this is/may be working but it’s unclear. Sounds like a relatively recent development. Thanks, Wes ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 18, 2006, 10:36pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/2 "2006-04-18T22:36:10Z")
Wes G. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) writes: > Can anyone explain how the RI documentation for RubyGems may be: > > 1. generated > > 2. subsequently accessed via RI? I think if you do an ‘rdoc -R’ in your gems directory it will create ri-accessible documentation. When I did this, it took an exceedingly long time to finish, so I’m wondering if there’s a better way to do it. -Phil H. ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 18, 2006, 10:43pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/3 "2006-04-18T22:43:53Z")
Phil, Which directory is the correct one to do it in? Wes Phil H. wrote: > Wes G. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) writes: > > > Can anyone explain how the RI documentation for RubyGems may be: > > > > 1. generated > > > > 2. subsequently accessed via RI? > > I think if you do an ‘rdoc -R’ in your gems directory it will create > ri-accessible documentation. When I did this, it took an exceedingly > long time to finish, so I’m wondering if there’s a better way to do > it. > > -Phil H. ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 18, 2006, 10:57pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/4 "2006-04-18T22:57:51Z")
Wes G. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) writes: > Which directory is the correct one to do it in? On my system (Ubuntu) it’s /usr/lib/ruby/gems/1.8/gems/ I don’t know that it would be consistent across platforms. -Phil H. ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 19, 2006, 2:14am UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/5 "2006-04-19T02:14:31Z")
On Apr 18, 2006, at 13:55, Phil H. wrote: > Wes G. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) writes: > > > Which directory is the correct one to do it in? > > On my system (Ubuntu) it’s /usr/lib/ruby/gems/1.8/gems/ > > I don’t know that it would be consistent across platforms. Doesn’t that depend on the question? If Wes wants documentation for Gems that he has installed, on my system, they’re in (installation root)/lib/ruby/gems/1.8/gems/(individual gems) However, RubyGems couldn’t install itself as a Gem, so it’s in (installation root)/lib/ruby/site\_ruby/1.8/rubygems On Mac OSX, (installation root) has defaulted to /usr/local, although I installed Ruby 1.8.4 in /Library/Ruby instead. To make ri documentation for RubyGems itself, you’d go to the latter directory, then run rdoc. You’ll have to figure out if you want to use -r or -R. I got tired of playing guessing games with ri, so I generate all my RDoc files as HTML now. ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 18, 2006, 11:22pm UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/6 "2006-04-18T23:22:38Z")
On Wed, 2006-04-19 at 05:12 +0900, Wes G. wrote: > Can anyone explain how the RI documentation for RubyGems may be: > > 1. generated > > 2. subsequently accessed via RI? If you don’t care about the regular rdoc (for gem\_server), this might help: [http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/175337](http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/175337) ---
**Author:** ![weyus](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/w/7ab992/32.png) [@weyus](https://www.ruby-forum.com/u/weyus)\ **Post date:** [April 19, 2006, 2:21am UTC](https://www.ruby-forum.com/t/ri-documentation-for-rubygems/94038/7 "2006-04-19T02:21:46Z")
Wes G. wrote: > Can anyone explain how the RI documentation for RubyGems may be: > > 1. generated > > 2. subsequently accessed via RI? > > Any info. is appreciated - my research tells me that this is/may be > working but it’s unclear. Sounds like a relatively recent development. This won’t help you immediately, but the next version of rubygems will generate the RI docs for each installed gem automatically. We will probabaly release a gemri command that will pick up the gem’ed RI docs as well. (gemri is just a simple wrapper that setups up the right paths). – – Jim W.