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

John Gabriele jmg3000 at gmail.com
Tue Jun 6 11:43:28 EDT 2006


On 6/6/06, Jim Weirich <jim.weirich at gmail.com> wrote:
>
> It is in CVS head and is available in the latest beta release.  You can get
> the beta with:
>
>    gem  update --system --source http://onestepback.org/betagems

Neat!

After running that update, I see that I've now got:

* new bin/gemlock and bin/index_gem_repository.rb programs,
* a lib/ruby/gems/1.8/cache/rubygems-update-0.8.11.15.gem file present,
* a lib/ruby/gems/1.8/gems/rubygems-update-0.8.11.15 directory filled
with its stuff, and this file
* lib/ruby/gems/1.8/specifications/rubygems-update-0.8.11.15.gemspec


----------------------------------------------------------
# gem query --local

*** LOCAL GEMS ***

[snip]

rubygems-update (0.8.11.15)
    RubyGems Update GEM

sources (0.0.1)
    This package provides download sources for remote gem installation


----------------------------------------------------
# gem help rdoc
[snip]
  Options:
        --all                        Generate RDoc/RI documentation
for all installed gems
        --[no-]rdoc                  Include RDoc generated documents
        --[no-]ri                    Include RI generated documents
[snip]

--------------------------------------------------------
# gem rdoc --all
Installing ri documentation for rake-0.7.1...
Installing RDoc documentation for rake-0.7.1...

(Hmm... none for RedCloth nor BlueCloth.)

Ah. Now lib/ruby/gems/1.8/doc/rake-0.7.1 has an ri directory in it
alongside the rdoc directory, and it's loaded with ri docs (yaml
files). :)

Trying it out, just as an example:

ri --doc-dir /opt/ruby-1.8.4/lib/ruby/gems/1.8/doc/rake-0.7.1/ri
Rake::FileList.exclude

works nicely. :)

Thanks,
---John


More information about the Rubygems-developers mailing list