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.
- D
- G
- L
- N
- R
- S
[R] | rdoc_version | Loaded version of RDoc. Set by ::load_rdoc |
[RW] | force | Force installation of documentation? |
[RW] | generate_rdoc | Generate rdoc? |
[RW] | generate_ri | Generate ri data? |
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 disabled through generate_rdoc
and
generate_ri
respectively.
# File ../ruby/lib/rdoc/rubygems_hook.rb, line 74 def initialize spec, generate_rdoc = true, generate_ri = true @doc_dir = spec.doc_dir @file_info = nil @force = false @rdoc = nil @spec = spec @generate_rdoc = generate_rdoc @generate_ri = generate_ri @rdoc_dir = spec.doc_dir 'rdoc' @ri_dir = spec.doc_dir 'ri' end
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
# File ../ruby/lib/rdoc/rubygems_hook.rb, line 106 def document generator, options, destination options = options.dup options.exclude ||= [] # TODO maybe move to RDoc::Options#finish options.setup_generator generator options.op_dir = destination options.finish @rdoc.options = options @rdoc.generator = options.generator.new options say "Installing #{generator} documentation for #{@spec.full_name}" FileUtils.mkdir_p options.op_dir Dir.chdir options.op_dir do begin @rdoc.class.current = @rdoc @rdoc.generator.generate @file_info ensure @rdoc.class.current = nil end end end
Generates RDoc and ri data
# File ../ruby/lib/rdoc/rubygems_hook.rb, line 133 def generate return unless @generate_ri or @generate_rdoc setup ::RDoc::RDoc.reset options = ::RDoc::Options.new options.default_title = "#{@spec.full_name} Documentation" options.files = [] options.files.push(*@spec.require_paths) options.files.push(*@spec.extra_rdoc_files) args = @spec.rdoc_options case config_args = Gem.configuration[:rdoc] when String then args = args.concat config_args.split when Array then args = args.concat config_args end delete_legacy_args args options.parse args options.quiet = !Gem.configuration.really_verbose @rdoc = new_rdoc @rdoc.options = options Dir.chdir @spec.full_gem_path do @file_info = @rdoc.parse_files options.files end document 'ri', options, @ri_dir if @generate_ri and (@force or not File.exist? @ri_dir) document 'darkfish', options, @rdoc_dir if @generate_rdoc and (@force or not File.exist? @rdoc_dir) end
Is rdoc documentation installed?
Removes generated RDoc and ri data
Is ri data installed?
Prepares the spec for documentation generation