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
Attributes
| [R] | rdoc_version | Loaded version of |
| [RW] | force | Force installation of documentation? |
| [RW] | generate_rdoc | Generate rdoc? |
| [RW] | generate_ri | Generate ri data? |
Class Public methods
generation_hook(installer, specs) Link
Post installs hook that generates documentation for each specification in specs
# File ruby/lib/rdoc/rubygems_hook.rb, line 48 def self.generation_hook installer, specs start = Time.now types = installer.document generate_rdoc = types.include? 'rdoc' generate_ri = types.include? 'ri' specs.each do |spec| new(spec, generate_rdoc, generate_ri).generate end return unless generate_rdoc or generate_ri duration = (Time.now - start).to_i names = specs.map(&:name).join ', ' say "Done installing documentation for #{names} after #{duration} seconds" end
new(spec, generate_rdoc = false, generate_ri = true) Link
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.
# File ruby/lib/rdoc/rubygems_hook.rb, line 85 def initialize spec, generate_rdoc = false, generate_ri = true @doc_dir = spec.doc_dir @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
Instance Public methods
delete_legacy_args(args) Link
Removes legacy rdoc arguments from args
document(generator, options, destination) Link
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 116 def document generator, options, destination generator_name = generator options = options.dup options.exclude ||= [] # TODO maybe move to RDoc::Options#finish options.setup_generator generator options.op_dir = destination Dir.chdir @spec.full_gem_path do options.finish end generator = options.generator.new @rdoc.store, options @rdoc.options = options @rdoc.generator = generator say "Installing #{generator_name} 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 ensure @rdoc.class.current = nil end end end
generate() Link
Generates RDoc and ri data
# File ruby/lib/rdoc/rubygems_hook.rb, line 149 def generate return if @spec.default_gem? return unless @generate_ri or @generate_rdoc setup options = nil args = @spec.rdoc_options args.concat @spec.source_paths args.concat @spec.extra_rdoc_files 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 Dir.chdir @spec.full_gem_path do options = ::RDoc::Options.new options.default_title = "#{@spec.full_name} Documentation" options.parse args end options.quiet = !Gem.configuration.really_verbose @rdoc = new_rdoc @rdoc.options = options store = RDoc::Store.new store.encoding = options.encoding store.dry_run = options.dry_run store.main = options.main_page store.title = options.title @rdoc.store = store say "Parsing documentation for #{@spec.full_name}" Dir.chdir @spec.full_gem_path do @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
rdoc_installed?() Link
Is rdoc documentation installed?
ri_installed?() Link
Is ri data installed?
setup() Link
Prepares the spec for documentation generation