diff options
author | Brice Figureau <brice-puppet@daysofwonder.com> | 2008-11-15 13:21:00 +0100 |
---|---|---|
committer | James Turnbull <james@lovedthanlost.net> | 2008-11-17 21:06:00 +1100 |
commit | dc192b00dc2c44b6174cb4a84663e8ad4e561d3c (patch) | |
tree | 03687997d058008de0a5a9d70a0bae76e24828f4 /lib/puppet/util/autoload.rb | |
parent | 2c05a0abcb55347c179e66bb0c9d23698e729046 (diff) | |
download | puppet-dc192b00dc2c44b6174cb4a84663e8ad4e561d3c.tar.gz puppet-dc192b00dc2c44b6174cb4a84663e8ad4e561d3c.tar.xz puppet-dc192b00dc2c44b6174cb4a84663e8ad4e561d3c.zip |
Manifest documentation generation
There is currently two type of documentation generation
for manifests (module or modulepath):
* RDoc HTML generation for modules and global manifests
* console output for sole manifest
Both version handles classes, defines, nodes, global
variable assignements, and resources when --all is used.
The usage is the following:
For the rdoc variant:
$ puppetdoc --mode rdoc --outputdir doc
It uses the puppet.conf configuration file to get the modulepath
and manifestdir settings. Those are overridable on the
command line with --modulepath and --manifestdir.
For the console output version:
$ puppetdoc /path/to/manifests
Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>
Diffstat (limited to 'lib/puppet/util/autoload.rb')
0 files changed, 0 insertions, 0 deletions