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

Uploaded Source

Built Distribution

ansible_doctor-0.2.5-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-0.2.5.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.4.0-72-generic

File hashes

Hashes for ansible-doctor-0.2.5.tar.gz
Algorithm Hash digest
SHA256 b7591287127dcbb81749019f57f7ca93c464f52353c08c7d5b9e9c1f0e451a3a
MD5 719982f66aa52d7f58424fafd1c5ae7d
BLAKE2b-256 8252c8fdf2d94b494084a27de1224c4d706795890a05e5c86a607a9e212821be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.4.0-72-generic

File hashes

Hashes for ansible_doctor-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e528f307251ee4bc40edc09c87cabf7bc8098afae9248d97ac1d1e44d6779de8
MD5 92948e0ea19fc26134054a7b7411a858
BLAKE2b-256 1bfb17e4bef630b8d691e0612cbb7db3a520fdf669857f1c673eeb0fa3f98097

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