detroit-rdoc - generate rdoc api documentation via detroit
The RDoc plug-in for Detroit utilizes the rdoc documentation tool to generate API documentation for a project. It can also be used to generate ri documentation file.
This plug-in package also includes detroit-ri(5).
The following options can be used in the Detroit toolchain file to define an RDoc tool instance.
title - Title of documents. Defaults to general metadata title field.
output - Where to save rdoc files. The default is doc/.
format - Documentation format. This defaults to ENV['RDOC_FORMAT']
or 'darkfish'.
template - Template to use. Some formats support multiple templates.
This defaults to ENV['RDOC_TEMPLATE'].
main - Main file. This can be a file pattern. This default is matched
to README{,.*}.
files/include - Which files to document. The default is lib/.
exclude - Paths to specifically exclude.
ignore - File patterns to ignore.
adfile - Ad file html snippet to add to html rdocs.
extra - Additional options passed to the rdoc command.
Option defaults are fairly typical. So the simplest entry is something like:
rdoc:
output: doc/
A more complex example might look like:
rdoc:
title: MyApp API
include:
- lib
- [A-Z]*.*
ignore:
- '*.yml'
output: site/api
main: INTRO.rdoc
format: hanna
The above examples use the YAML-base assembly format. Assembly files can also be Ruby-based. See Detroit documentation for more details.
For more information:
Copyright (c) 2010 Rubyworks
Detroit RDoc is distributable in accordance with the GPL v3 license.
detroit(1), rdoc(1), detroit-ri(5)