Puppet Strings generates documentation for Puppet code and extensions written in Puppet and Ruby. Strings processes code and YARD-style code comments to create documentation in HTML, Markdown, or JSON formats.
|Issues||Puppet JIRA Tracker|
|Contributing||CONTRIBUTING.md and COMMITTERS.md|
Installing Puppet Strings
- Ruby 2.1.9 or newer
- Puppet 4.0 or newer
Install Puppet Strings
Install the YARD gem by running
gem install yard
puppet-stringsgem by running
gem install puppet-strings
Optional: Set YARD options for Strings
To use YARD options with Puppet Strings, specify a
yardoptsfile in the same directory in which you run
puppet strings. Puppet Strings supports the Markdown format and automatically sets the YARD
To see a list of available YARD options, run
yard help doc. For details about YARD options configuration, see the YARD docs.
Generating documentation with Puppet Strings
By default, Puppet Strings outputs documentation as HTML, or you can specify JSON or Markdown output instead.
Strings generates reference documentation based on the code and Strings code comments in all Puppet and Ruby source files under the
Strings outputs HTML of the reference information and the module README to the module's
./doc/ directory. This output can be rendered in any browser.
JSON and Markdown output include the reference documentation only. Strings sends JSON output to either STDOUT or to a file. Markdown output is written to a REFERENCE.md file in the module's main directory.
Here are a few other good resources for getting started with documentation:
Developing and Contributing
We love contributions from the community!
If you'd like to contribute to
puppet-strings, check out CONTRIBUTING.md to get information on the contribution process.
If you plan on developing features or fixing bugs in Puppet Strings, it is essential that you run specs before opening a pull request.
To run specs, run the
spec rake task:
$ bundle install --path .bundle/gems $ bundle exec rake spec
There is also an active #puppet channel on the Freenode IRC network.
We use semantic version numbers for our releases and recommend that users upgrade to patch releases and minor releases as they become available.
Bug fixes and ongoing development will occur in minor releases for the current major version. Security fixes will be ported to a previous major version on a best-effort basis, until the previous major version is no longer maintained.