sphinxcontrib-ansibleautodoc is an sphinx extension which can search task in ansible playbook and generate document.
install
pip install sphinxcontrib-ansibleautodoc
and add ‘sphinxcontrib.ansibleautodoc’ in extensions in your conf.py.
extensions = [
'sphinxcontrib.ansibleautodoc',
]
How to use
Currently there is one directive called ansibleautotask.
ansibleautotask
.. ansibleautotask:: second task :playbook: ../ansible/web.yml
The contents of this directive is an ansible task name. If task does not have a name, directive can not find.
playbook option is for specify initial ansible playbook. ansibleautodoc scan the playbook and read include and roles as followes. So you need only one playbook file.
Output Example
License
2-clause BSD License
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib_ansibleautodoc 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib_ansibleautodoc-0.0.5.tar.gz | 5.1 kB | Details |
Release files / sphinxcontrib_ansibleautodoc-0.0.5.tar.gz
| Download URL | sphinxcontrib_ansibleautodoc-0.0.5.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
73b4032f7a64ec0ac2ba8d85175aa4d78534272260fa4162f2aa1e8d3262d5f4
|
|
BLAKE2b-256 checksum How to use checksums |
9854e17e01dee0627f215378f44c8f502db63ff784022372bfec4a8242495fb6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
