cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Indicate module_formatter can produce boilerplate DOCUMENTATION

Browse source 
add ./hacking/
This commit is contained in:
Jan-Piet Mens 2012-10-16 16:06:00 +02:00
parent fea5d36417
commit 9991dfee6c
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docsite/rst/moduledev.rst
View file

@ -328,8 +328,9 @@ Here's a correctly formatted YAML document we could use for a
.. literalinclude:: ../DOCUMENTATION.yaml
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
starting point when writing your own docs.
github repository, and you can have that generated with
``./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::