Man page - puppet-strings(1)

Packages contains this manual

Package:  puppet-strings
apt-get install puppet-strings

Manuals in package:
• puppet-strings(1)
Documentations in package:
• puppet-strings

Manual

PUPPET-STRINGS

NAME
SYNOPSIS
DESCRIPTION
ACTIONS
OPTIONS
FORMATS
EXAMPLES
ADDITIONAL DOCUMENTATION
BUGS
AUTHOR

---

NAME

puppet-strings - Generate Puppet documentation with YARD

SYNOPSIS

puppet strings <action>
puppet strings --help

DESCRIPTION

Produce complete, user-friendly module documentation by using Puppet Strings. Strings uses tags and code comments, along with the source code, to generate documentation for a module's classes, defined types, functions, tasks, plans, and resource types and providers.

Puppet Strings is based on the YARD Ruby documentation tool.

ACTIONS

generate

Generate documentation from files.

server

Runs a local documentation server for the modules in the current Puppet
environment.

OPTIONS

--format FORMAT The rendering format to use (see FORMATS below)
--out The output file when using the markdown or json formats
--verbose Whether to log verbosely
--debug Whether to log debug information
--help Show the help screen

FORMATS

Possible formats are: "markdown", "textile", "rdoc", "ruby", "text", "html", or "none".

EXAMPLES

If you want to generate a single reference file, use something like:

$ puppet strings generate --format markdown --out REFERENCE.md

You can otherwise generate HTML documentation this way:

$ puppet strings generate

ADDITIONAL DOCUMENTATION

See the upstream documentation at:
<https://puppet.com/docs/puppet/latest/puppet_strings.html>

Code examples and style guide can be found at:
<https://puppet.com/docs/puppet/latest/puppet_strings_style.html>

BUGS

Bugs can be reported to your distribution's bug tracker or upstream at <https://github.com/puppetlabs/puppet-strings/issues> .

AUTHOR

Louis-Philippe Véronneau

---