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 | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib_ansibleautodoc-0.0.5.tar.gz | 5.1 kB | Without provenance | Details for sphinxcontrib_ansibleautodoc-0.0.5.tar.gz |
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 |
Security for sphinxcontrib_ansibleautodoc 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
