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

This version

1.0.0

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.0.0.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.9.7 Linux/5.4.0-84-generic

File hashes

Hashes for ansible-doctor-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5a845a040f8087ed4e78a7635d7e4f21107555cb8351e0045c46a13badfce72b
MD5 54a465b39b2884cfdad0a80c5c241d0a
BLAKE2b-256 b096bb1511d953eae9d4836bcd582459865780b54fa38ad94897dd686b130fcc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ansible_doctor-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7201ebb42a5f7055516954801432f0e786dfae2cb7eadb641125c76beb264e74
MD5 76c21038c2c110bdad3ae7338fab9326
BLAKE2b-256 294cc245ac9d642613163e464d95501294796e48a80542240327f1e9cb9e1e63

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