From 3eff279dd7423e1631497290ea4ee16d843bdd60 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Fri, 16 Feb 2018 13:04:10 -0500 Subject: [PATCH] updates to module testing (#36043) * updates to module testing gives those using internal modules an alternative * Copy edit --- docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index 3198e866aeb..c921e5f9446 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -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.