Module Generators
In: lib/puppet/util/rdoc/generators/puppet_generator.rb

Classes and Modules

Module Generators::ResourceContainer
Class Generators::HTMLPuppetClass
Class Generators::HTMLPuppetModule
Class Generators::HTMLPuppetNode
Class Generators::HTMLPuppetPlugin
Class Generators::HTMLPuppetResource
Class Generators::PuppetGenerator
Class Generators::PuppetGeneratorInOne

Constants

MODULE_DIR = "modules"   This module holds all the classes needed to generate the HTML documentation of a bunch of puppet manifests.

It works by traversing all the code objects defined by the Puppet RDoc::Parser and produces HTML counterparts objects that in turns are used by RDoc template engine to produce the final HTML.

It is also responsible of creating the whole directory hierarchy, and various index files.

It is to be noted that the whole system is built on top of ruby RDoc. As such there is an implicit mapping of puppet entities to ruby entitites:

        Puppet    =>    Ruby
        ------------------------
        Module          Module
        Class           Class
        Definition      Method
        Resource
        Node
        Plugin
        Fact
NODE_DIR = "nodes"
PLUGIN_DIR = "plugins"

[Validate]