Class: Gem::DocManager

Class | Gem::DocManager
In: | lib/rubygems/doc_manager.rb
Parent: | Object

The documentation manager generates RDoc and RI for RubyGems.

### Methods

configured_args configured_args= generate_rdoc generate_ri install_rdoc install_ri load_rdoc new rdoc_installed? rdoc_version run_rdoc setup_rdoc uninstall_doc update_ri_cache

### Included Modules

Gem::UserInteraction

### Public Class methods

configured_args()
configured_args=(args)
load_rdoc()

Load RDoc from a gem if it is available, otherwise from Ruby‘s stdlib

new(spec, rdoc_args="")

Create a document manager for `spec`. `rdoc_args` contains arguments for RDoc (template etc.) as a String.

rdoc_version()
update_ri_cache()

Updates the RI cache for RDoc 2 if it is installed

### Public Instance methods

generate_rdoc()

Generate the RDoc documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

generate_ri()

Generate the RI documents for this gem spec.

Note that if both RI and RDoc documents are generated from the same process, the RI docs should be done first (a likely bug in RDoc will cause RI docs generation to fail if run after RDoc).

install_rdoc()

Generate and install RDoc into the documentation directory

install_ri()

Generate and install RI into the documentation directory

rdoc_installed?()

Is the RDoc documentation installed?

run_rdoc(*args)

Run RDoc with `args`, which is an ARGV style argument list

setup_rdoc()
uninstall_doc()

Remove RDoc and RI documentation

[Validate]