Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How can I install ri and rdoc files for gems afterwards?

I normally don't need ri and rdoc, so I write in ~/.gemrc like this.

install: --no-ri --no-rdoc
update: --no-ri --no-rdoc

I want to install them afterwards when I have time. How can I install ri and rdoc files for installed gems afterwards?

like image 887
ironsand Avatar asked Aug 31 '13 05:08

ironsand


2 Answers

# See the relevant help.
gem help rdoc

# Generate rdoc and ri for the "foo" gem.
gem rdoc --ri foo

# Generate rdoc for all installed gems.
gem rdoc --all
like image 170
Todd A. Jacobs Avatar answered Nov 08 '22 20:11

Todd A. Jacobs


According to chapter 10 of the RubyGems Command reference, you can use gem rdoc to install rdoc.

Here is an excerpt...

Usage: gem rdoc [args] [options]

  Options:
        --all                        Generate RDoc documentation for all installed gems
    -v, --version VERSION            Specify version of gem to rdoc

  Common Options:
        --source URL                 Use URL as the remote source for gems
    -p, --[no-]http-proxy [URL]      Use HTTP proxy for remote operations
    -h, --help                       Get help on this command
        --config-file FILE           Use this config file instead of default
        --backtrace                  Show stack backtrace on errors
        --debug                      Turn on Ruby debugging

  Arguments:
    GEMNAME          The gem to generate RDoc for (unless --all)

  Summary:
    Generates RDoc for pre-installed gems

  Defaults:
    --version '> 0.0.0'
like image 1
ddavison Avatar answered Nov 08 '22 19:11

ddavison