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 your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. HTML or XML).

ansible-doctor is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.

You can find the full documentation at https://ansible-doctor.geekdocs.de.

Contributors

Special thanks goes 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 1.1.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 1.1.4
File Size Uploaded Provenance Actions
ansible-doctor-1.1.4.tar.gz 26.0 kB Without provenance Details for ansible-doctor-1.1.4.tar.gz

Built distribution (wheel)

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

Total release size: 67.7 kB

Release files / ansible-doctor-1.1.4.tar.gz

Download URL ansible-doctor-1.1.4.tar.gz
Size 26.0 kB
Tags Source
SHA-256 checksum
How to use checksums
afcf9ae3cab0881afa0869f2a33f48dadf4f064e62889310c33a1302767022db
BLAKE2b-256 checksum
How to use checksums
89281c082700c1a2a2f4bc1d4fc50a7e13a5f1879ce8487bf048717007ea8752
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.10.0 Linux/5.4.0-84-generic

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

Download URL ansible_doctor-1.1.4-py3-none-any.whl
Size 41.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f7ac121f178776f908db314e2041c09ca7fabe678ec13a32ab4d5dbf91f28a3
BLAKE2b-256 checksum
How to use checksums
3a40fe1df4266bfff1027cb516ce4a9749fb3f8ad64b6e1ff6f9e4d64bb3474a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.11 CPython/3.10.0 Linux/5.4.0-84-generic

Security for ansible-doctor 1.1.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

1.1.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