internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 22:02:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1353 from jpmens/moduledev1

Browse Source 
Indicate module_formatter can produce boilerplate DOCUMENTATION
This commit is contained in:
Michael DeHaan
2012-10-17 05:08:10 -07:00
parent 47c4775e94 9991dfee6c
commit 50abc73bd2
1 changed files with 3 additions and 2 deletions
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 .. 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::