New script utils/ansible-doc-test
This script can check modules in roles and also plugins folder to have a valid documentation section. It is using anisble-doc internally. usage: Usage: ansible-doc-test [options] [path] optional arguments: -h, --help show this help message and exit -v increase output verbosity There are different verbose levels: -v Shows the modules that are tested at the moment. -vv Shows the modules and also the doc output. You can use the script to check specific modules, roles or modules in roles. Here are some examples: Test specific module with verbose level 1: $ utils/ansible-doc-test -vv plugins/modules/ipauser.py Test all modules in plugins folder: $ utils/ansible-doc-test -v plugins Test ipaserver_prepare.py in ipaserver role: $ utils/ansible-doc-test -v roles/ipaserver/library/ipaserver_prepare.py Test all modules in ipaserver role: $ utils/ansible-doc-test -v roles/ipaserver Test all roles: $ utils/ansible-doc-test -v roles Test all roles and modules in plugins: $ utils/ansible-doc-test -v
Loading
Please register or sign in to comment