Skip to main content

Generate documentation from annotated Ansible roles using templates.

Project description

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.

Project details


Release history Release notifications | RSS feed

This version

7.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible_doctor-7.0.0.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

ansible_doctor-7.0.0-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file ansible_doctor-7.0.0.tar.gz.

File metadata

  • Download URL: ansible_doctor-7.0.0.tar.gz
  • Upload date:
  • Size: 28.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Linux/5.15.0-122-generic

File hashes

Hashes for ansible_doctor-7.0.0.tar.gz
Algorithm Hash digest
SHA256 abae90936da122d1ef7198d3ce37a6a5e74d53c1d8d1b401b4e54a24dfde5365
MD5 30f295ac1429b294f30ac9a4f1fde9c2
BLAKE2b-256 3cc27e379c837d00ae1ab4441aa4f97246d73434ef4af3346a8546d5bd452336

See more details on using hashes here.

File details

Details for the file ansible_doctor-7.0.0-py3-none-any.whl.

File metadata

  • Download URL: ansible_doctor-7.0.0-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.13.0 Linux/5.15.0-122-generic

File hashes

Hashes for ansible_doctor-7.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fe6ac69b17a6ceb33b690922e421a3897866d48044e1308dcd9807894e14003
MD5 d1d621f2e649c0e976ca01964e66ba1a
BLAKE2b-256 8e9e7853ea88edfc48ef54c86d90fd31e6f37624dba46254b1948fa38f227e40

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page