ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

updates to module testing (#36043)

Browse source 
* updates to module testing

gives those using internal modules an alternative

* Copy edit
This commit is contained in:
Brian Coca 2018-02-16 13:04:10 -05:00 committed by scottb
parent ac169f5ffd
commit 3eff279dd7
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file

@ -429,6 +429,9 @@ Examples can be found by searching for ``extends_documentation_fragment`` under
Testing documentation
---------------------
The simplest way to check if your documentation works is to use ``ansible-doc`` to view it. Any parsing errors will be apparent, and details can be obtained by adding ``-vvv``.
If you are going to submit the module for inclusion in the main Ansible repo you should make sure that it renders correctly as HTML.
Put your completed module file into the ``lib/ansible/modules/$CATEGORY/`` directory and then
run the command: ``make webdocs``. The new 'modules.html' file will be
built in the ``docs/docsite/_build/html/$MODULENAME_module.html`` directory.