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

Project details


Release history Release notifications | RSS feed

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-1.4.1.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

ansible_doctor-1.4.1-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file ansible-doctor-1.4.1.tar.gz.

File metadata

  • Download URL: ansible-doctor-1.4.1.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.4.0-110-generic

File hashes

Hashes for ansible-doctor-1.4.1.tar.gz
Algorithm Hash digest
SHA256 fa96d1e8a0bb79bda9e8d07a8b91108a4297e3fb75d35f2daf234c4007985c11
MD5 3b0ac0fcffbccbbb7e8ad72a96decaad
BLAKE2b-256 a9348df4fe2da0cce8d13a74e5ceb0decf98243834d3c2e11346a160370c8d36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.5 Linux/5.4.0-110-generic

File hashes

Hashes for ansible_doctor-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8f80d1f4a56fecc93be5bbfefff76284c662b9358679e703f043b5091ea308d2
MD5 b777c6ca880973982852740537af0d00
BLAKE2b-256 338193b9cb470dd6202cc276c555cbd8e72e516f6d243608498ec355f91eea90

See more details on using hashes here.

Supported by

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