Indicate module_formatter can produce boilerplate DOCUMENTATION
add ./hacking/
This commit is contained in:
parent
fea5d36417
commit
9991dfee6c
1 changed files with 3 additions and 2 deletions
|
@ -328,8 +328,9 @@ Here's a correctly formatted YAML document we could use for a
|
||||||
.. literalinclude:: ../DOCUMENTATION.yaml
|
.. literalinclude:: ../DOCUMENTATION.yaml
|
||||||
|
|
||||||
This is available in the 'examples/' directory of the of the Ansible
|
This is available in the 'examples/' directory of the of the Ansible
|
||||||
github repository. You can copy it into your module and use it as a
|
github repository, and you can have that generated with
|
||||||
starting point when writing your own docs.
|
``./hacking/module_formatter.py -G``. You can copy it into your module and use
|
||||||
|
it as a starting point when writing your own docs.
|
||||||
|
|
||||||
Include it in your module file like this::
|
Include it in your module file like this::
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue