Skip to main content

ansible-doctor

Annotation based documentation for your Ansible roles

Build Status Docker Hub Quay.io Python Version PyPI Status PyPI Release GitHub contributors Source: GitHub License: GPL-3.0

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.

Metadata

Release files for ansible-doctor 8.4.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-doctor 8.4.4
File Size Uploaded Provenance Actions
ansible_doctor-8.4.4.tar.gz 31.4 kB Without provenance Details for ansible_doctor-8.4.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ansible-doctor 8.4.4
File Interpreter ABI Platform Actions
ansible_doctor-8.4.4-py3-none-any.whl Python 3 none any Details for ansible_doctor-8.4.4-py3-none-any.whl

Total release size: 75.8 kB

Release files / ansible_doctor-8.4.4.tar.gz

Download URL ansible_doctor-8.4.4.tar.gz
Size 31.4 kB
Tags Source
SHA-256 checksum
How to use checksums
934cf8248a434713f6c231c8f7750df346712ac18a1add79ea0058f8448307a0
BLAKE2b-256 checksum
How to use checksums
c8782568685d70fde101f41e7ff5617a86bf013c40d3a7bc70800054564f0ee9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.14.10 Linux/6.8.0-138-generic

Release files / ansible_doctor-8.4.4-py3-none-any.whl

Download URL ansible_doctor-8.4.4-py3-none-any.whl
Size 44.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
29a8abc0b2e91494ec4d560acc17f915254d5f5df1fd7f40350b8e624f900761
BLAKE2b-256 checksum
How to use checksums
dc26e51836a7cc390a7ba8887939f281cf83aadc76b8c48dcbd7115c153e8f42
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.5.1 CPython/3.14.10 Linux/6.8.0-138-generic

Security for ansible-doctor 8.4.4

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.

Release history Release notifications | RSS feed

This release

8.4.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page