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

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

Uploaded Source

Built Distribution

ansible_doctor-1.1.8-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.1.8.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.4.0-90-generic

File hashes

Hashes for ansible-doctor-1.1.8.tar.gz
Algorithm Hash digest
SHA256 239c33a952b5747a01ca271d7f880b1d5b5d7fddc5d2f5d02aaa345078b7a590
MD5 c6949f47019d40f92edfb40f43f6e5bf
BLAKE2b-256 29fac5576dc7d719479a6294d73136d4fdc16969b63156f07c94dc8304e99e38

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-1.1.8-py3-none-any.whl
  • Upload date:
  • Size: 41.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.4.0-90-generic

File hashes

Hashes for ansible_doctor-1.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6ccbc199652f2edae1be57a517a74a056091ef9444da8e74fb5c3b0530715745
MD5 26d5856df9b6c77bf3ae936153408ff0
BLAKE2b-256 cc7280276674cc3a5bd367e5afa8c454426d07038d9702cb708e2535a2a120f0

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