Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Can you install documentation for existing gems?

Rubyinside mentioned a blog post on how to speed up gem installation by not installing RI or RDoc.

Is it possible to install a gem and subsequently install documentation at a later date, so you can hack in haste and RTFM at leisure?

like image 976
Andrew Grimm Avatar asked Mar 20 '09 01:03

Andrew Grimm


2 Answers

> gem help rdoc

Usage: gem rdoc [args] [options]
Options:
      --all                        Generate RDoc/RI documentation for all
                                   installed gems
      --[no-]rdoc                  Include RDoc generated documents
      --[no-]ri                    Include RI generated documents
  -v, --version VERSION            Specify version of gem to rdoc
Arguments:
  GEMNAME       gem to generate documentation for (unless --all)
Summary:
  Generates RDoc for pre-installed gems
Defaults:
  --version '>= 0' --rdoc --ri
like image 164
Jeff Dallien Avatar answered Oct 11 '22 01:10

Jeff Dallien


If you run gem rdoc --all it will generate documentation for all your gems.

You can also use the following command to generate docs for gems in your bundle:

bundle list | egrep '\*' | sed -e 's/* \(.*\) (.*)/\1/g' | xargs -n 1 gem rdoc

You may need to adapt to your needs and also if bundle changes its output format.

like image 25
simao Avatar answered Oct 11 '22 03:10

simao