Forum: Ruby on Rails Getting gem rdoc via ri?

Announcement (2017-05-07): is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see and for other Rails- und Ruby-related community platforms.
John W. (Guest)
on 2006-01-27 21:45

I'm working with the new RadRails release (0.5.3), which has a very
nifty inclusion of ri courtesy of RDT.

Problem is, although I've generated rdoc for all installed gems with
"gem rdoc --all", it's not accessible through ri. I see some posts here
and there about this still the necessary way to incorporate
the rails rdoc into ri?

John W. (Guest)
on 2006-01-30 16:34

I posted my question to the Ruby list and got a few very good was my solution, FYR:
Apparently, someone had already thought of doing this and didn't, as
evidenced by the following lines in rubygems/doc_manager.rb:

 #TODO: Why is this throwing an error?
          #ri =
          #ri.document(['-R'] + source_dirs)

Anyway, I was successful...I'll look at making this more integrated and
submitting as a patch, but for the quick hack all it took was changing
the following line (58 in my version):

r.document(['--quiet', '--op', rdoc_dir] + @rdoc_args.flatten +


r.document(['--quiet', '--op', '--merge', '-r', '--ri-system', rdoc_dir]
+ @rdoc_args.flatten + source_dirs)

It worked perfectly...all Rails classes, etc, are now in ri.

Thanks guys!

Brandt Lofton (Guest)
on 2006-01-30 19:50
(Received via mailing list)
This is a great tip.. Thanks a TON...
This topic is locked and can not be replied to.