1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
==============
puppet-strings
==============
---------------------------------------
Generate Puppet documentation with YARD
---------------------------------------
:Author: Louis-Philippe Véronneau
:Date: 2024
:Manual section: 1
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.
|
