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

This version

1.3.4

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

Uploaded Source

Built Distribution

ansible_doctor-1.3.4-py3-none-any.whl (43.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ansible-doctor-1.3.4.tar.gz
Algorithm Hash digest
SHA256 f9a76a9d9afa826348ab1c3d862990876b87adcf365b90bfce64f8b251139e89
MD5 491ff70ddc6b2438b7e4cb731088db8f
BLAKE2b-256 72d2c192b244871b750b67231eaf9811cf35be15713dac78f5b6d162d3dcb1db

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ansible_doctor-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7e2c8bccaa6cfea85d6bb0ee7d1faca7fb5b40899f22a548e6ff10afa33b978c
MD5 f08f90f7e8d5bc753d86d6af4ad06c19
BLAKE2b-256 2bc55f3ad739b6989c0b7e82e45fc9011028a622626eae739261015bc2865da4

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