Service
The ri documentation plugin provides services for generating ri documentation.
By default it generates the ri documentaiton at doc/ri, unless an ‘ri’ directory exists in the project’s root directory, in which case the ri documentation will be stored there.
This plugin provides the following cycle-phases:
main:document - generate ri docs main:reset - mark ri docs out-of-date main:clean - remove ri docs site:document - generate ri docs site:reset - mark ri docs out-of-date site:clean - remove ri docs
Deafult extra options to add to rdoc call.
Default location to store ri documentation files.
Locations to check for existance in deciding where to store ri documentation.
Remove ri products.
# File lib/plugins/syckle/ridoc.rb, line 112 def clean if File.directory?(output) rm_r(output) status "Removed #{output}" #unless trial? end end
Generate ri documentation. This utilizes rdoc to produce the appropriate files.
# File lib/plugins/syckle/ridoc.rb, line 77 def document output = self.output input = self.files exclude = self.exclude include_files = files.to_list.uniq exclude_files = exclude.to_list.uniq filelist = amass(include_files, exclude_files) if outofdate?(output, *filelist) or force? status "Generating #{output}" cmdopts = {} cmdopts['op'] = output cmdopts['exclude'] = exclude ridoc_target(output, include_files, cmdopts) touch(output) else status "RI docs are current (#{output})" end end
Generated with the Darkfish Rdoc Generator 2.