ansible-doctor
Annotation based documentation for your Ansible roles
This project is based on the idea (and at some parts on the code) of ansible-autodoc by Andres Bott so credits goes to him for his work.
ansible-doctor is a simple annotation like documentation generator based on Jinja2 templates. While ansible-doctor comes with a default template called readme, it is also possible to write custom templates to customize the output or render the data to other formats like HTML or XML as well.
ansible-doctor is designed to work within a CI pipeline to complete the existing testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.
The full documentation is available at https://ansible-doctor.geekdocs.de.
Contributors
Special thanks to all contributors. If you would like to contribute, please see the instructions.
License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for ansible-doctor 8.4.3
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 |
|---|---|---|---|---|
| ansible_doctor-8.4.3.tar.gz | 31.4 kB | Without provenance | Details for ansible_doctor-8.4.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ansible_doctor-8.4.3-py3-none-any.whl | Python 3 | none | any | Details for ansible_doctor-8.4.3-py3-none-any.whl |
Total release size: 75.8 kB
Release files / ansible_doctor-8.4.3.tar.gz
| Download URL | ansible_doctor-8.4.3.tar.gz |
|---|---|
| Size | 31.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d4a1faabd443f2e7f2b3c01219104afb6bc9082eecbcff41d46b6adbd48df5b
|
|
BLAKE2b-256 checksum How to use checksums |
531cf2ef5c687ae0e84637fae18736511cf72abbc5bd3cbdd4890148bb518698
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-138-generic
|
Release files / ansible_doctor-8.4.3-py3-none-any.whl
| Download URL | ansible_doctor-8.4.3-py3-none-any.whl |
|---|---|
| Size | 44.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8dc14ed8c1e92dd7dbd863ac4cb3b55f4322fcc01d516f5d53c52dd726964591
|
|
BLAKE2b-256 checksum How to use checksums |
9037db416e1655d787791e1c028a9f321db0a337d248a0890a9a3e35d5799213
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.5.1 CPython/3.14.8 Linux/6.8.0-138-generic
|
Security for ansible-doctor 8.4.3
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.
