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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-0.2.6.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.6.tar.gz
Algorithm Hash digest
SHA256 37bda1ae71a4e341528dabbc04b1ca4f5d0f805de20f16b63242858a352ab89e
MD5 d64ee94e9f89885b8ec138b8e431d85a
BLAKE2b-256 ff398005b463c21fbbf1eb2325af3dd3a47aaac488fabef20902f76d7f546a7e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-0.2.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c01abca3db90c946db745ebca27c6bd6223e2c95236d6902d51bcb8d370fb6c2
MD5 61721886df6a48cfc47908eaae983f61
BLAKE2b-256 bab208f138ee29b19221cabf49f32ccdc19ae217fbde23885f9a037a5f6cf974

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