Producing automatic HTML documentation

As your manifests get bigger and more complex, it can be helpful to create HTML documentation for your nodes and classes using an automatic documentation tool, puppet strings. Previous versions of Puppet included the doc option, which was used to produce documentation. However, it was deprecated in favor of puppet strings, a ruby gem.

Getting ready...

Install the puppet strings ruby gem. First install the YARD gem, then puppet-strings:

t@mylaptop ~ $ sudo /opt/puppetlabs/puppet/bin/gem install yard
[sudo] password for thomas: 
Fetching: yard-0.9.12.gem (100%)
--------------------------------------------------------------------------------
As of YARD v0.9.2:

RubyGems "--document=yri,yard...