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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 30beb6f6564eb92da9e61b59ad28c3d210600bf2eaaf02f914f3f1ed0a86fb1e
MD5 22ac75d1278ce4c453ff7525b4c700c7
BLAKE2b-256 7324c813522fa5c8b706545586d92e74b9940b4442cb4b81e2553ae6d71a13d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-1.3.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fddb9e226be03daf9d21459362bb6447147935a6e8aca4ae5f748b5ee88edf72
MD5 7f602c5a9427214941b1269da48a8133
BLAKE2b-256 180c2123c98f866d44f3e45576e0bf1d8fdd4e3048247b3a73d3746f01d0edce

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