Skip to content

Commit

Permalink
updates to module testing (#36043)
Browse files Browse the repository at this point in the history
* updates to module testing

gives those using internal modules an alternative

* Copy edit

(cherry picked from commit 3eff279)
  • Loading branch information
bcoca committed Feb 16, 2018
1 parent cf19661 commit 57bccd1
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/docsite/rst/dev_guide/developing_modules_documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 57bccd1

Please sign in to comment.