Gem::RDoc provides methods to generate RDoc and ri data for installed gems upon gem installation.

This file is automatically required by RubyGems 1.9 and newer.

Attributes
Read & Write

Force installation of documentation?

Read & Write

Generate rdoc?

Read & Write

Generate ri data?

Loaded version of RDoc. Set by ::load_rdoc

Class Methods

Post installs hook that generates documentation for each specification in specs

Loads the RDoc generator

Creates a new documentation generator for spec. RDoc and ri data generation can be enabled or disabled through generate_rdoc and generate_ri respectively.

Only generate_ri is enabled by default.

Instance Methods

Removes legacy rdoc arguments from args

Generates documentation using the named generator (“darkfish” or “ri”) and following the given options.

Documentation will be generated into destination

Generates RDoc and ri data

Is rdoc documentation installed?

Removes generated RDoc and ri data

Is ri data installed?

Prepares the spec for documentation generation