Before you submit a module for inclusion in the main Ansible repo, you must test your module documentation for correct HTML rendering and to ensure that the argspec matches the documentation in your Python file. The community pages offer more information on testing reStructuredText documentation.
To check the HTML output of your module documentation:
lib/ansible/modules/$CATEGORY/my_code.py
.cd /path/to/ansible/docs/docsite/
.MODULES=my_code make webdocs
.file:///path/to/ansible/docs/docsite/_build/html/my_code_module.html
.To build the HTML documentation for multiple modules, use a comma-separated list of module names: MODULES=my_code,my_other_code make webdocs
.
To ensure that your documentation matches your argument_spec
, run the validate-modules
test.
# If you don't already, ensure you are using your local checkout
source hacking/env-setup
./test/sanity/validate-modules/validate-modules --arg-spec --warnings lib/ansible/modules/$CATEGORY/my_code.py