[Rubygems-developers] rdoc, ri, and gem integration?

Jim Weirich jim at weirichhouse.org
Sat Jun 3 17:54:28 EDT 2006


John Gabriele wrote:
> Where does this cvs version of gem put the ri docs (yaml files) that
> it generates?

In the doc directory of the gem repository.

>> The install and
>> update commands supports both --rdoc and --ri switches.
> 
> Just curious, is it the default behaviour to generate and install both
> the rdoc->html and rdoc->yaml (ri) docs when you install a gem? If so,
> then what's the point of those --rdoc and --ri switches?

So you can say --no-rdoc and --no-ri

>>  The rdoc
>> command can also generate rdoc and ri docs at any time for any installed
>> command.
> 
> Not sure what you mean by "installed command", but...

Sorry, I meant any installed gem.

> I see that rdoc can make ri docs for the core/std modules
> (/opt/ruby-1.8.4/lib/ruby/1.8), and using the "--ri-system" option it
> places them into /opt/ruby-1.8.4/share/ri/1.8/system.
> 
> And that rdoc can make ri docs for site modules
> (/opt/ruby-1.8.4/lib/ruby/site_ruby/1.8), and using the "--ri-site"
> option it places them into /opt/ruby-1.8.4/share/ri/1.8/site.
> 
> And that rdoc ran make ri docs for any of my random oddball modules,
> and using the "--ri" option it places them into my own ~/.rdoc
> directory (though that's not working for me at the moment),
> 
> But rdoc doesn't seem to have an option for use when generating ri
> docs for gems. Or does it?

The gem rdoc command generates the RI docs too.  Is that what you are 
asking.

> How do most folks currently go about having ri docs for installed gems?

Most people don't yet,  the RI stuff is fairly recent.

-- Jim Weirich



More information about the Rubygems-developers mailing list