.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PUPPET-STRINGS" 1 "2019" "" ""
.SH NAME
puppet-strings \- Generate Puppet documentation with YARD
.SH SYNOPSIS
.nf
puppet strings \fI<action>\fP
puppet strings \fB\-\-help\fP
.fi
.sp
.SH DESCRIPTION
.sp
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\(aqs classes, defined types, functions, tasks, plans,
and resource types and providers.
.sp
Puppet Strings is based on the YARD Ruby documentation tool.
.SH ACTIONS
.nf
\fBgenerate\fP
.in +2
Generate documentation from files.
.in -2
.fi
.sp
.nf

.fi
.sp
.nf
\fBserver\fP
.in +2
Runs a local documentation server for the modules in the current Puppet
environment.
.in -2
.fi
.sp
.SH OPTIONS
.nf
\fB\-\-format\fP \fIFORMAT\fP  The rendering format to use (html, markdown or json)
\fB\-\-out\fP            The output file when using the markdown or json formats
\fB\-\-verbose\fP        Whether to log verbosely
\fB\-\-debug\fP          Whether to log debug information
\fB\-\-help\fP           Show the help screen
.fi
.sp
.SH EXAMPLES
.sp
If you want to generate a single reference file, use something like:
.INDENT 0.0
.INDENT 3.5
$ puppet strings generate \-\-format markdown \-\-out REFERENCE.md
.UNINDENT
.UNINDENT
.sp
You can otherwise generate HTML documentation this way:
.INDENT 0.0
.INDENT 3.5
$ puppet strings generate
.UNINDENT
.UNINDENT
.SH BUGS
.sp
Bugs can be reported to your distribution\(aqs bug tracker or upstream
at \fI\%https://tickets.puppetlabs.com/browse/PDOC\fP\&.
.SH AUTHOR
Louis-Philippe Véronneau
.\" Generated by docutils manpage writer.
.