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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.1.2.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.10.0 Linux/5.4.0-84-generic

File hashes

Hashes for ansible-doctor-1.1.2.tar.gz
Algorithm Hash digest
SHA256 2c57b11c3018baf3f463ebeb96fa81200505628b59fcd0f70f7615257af583c3
MD5 c66704a5c4b7eb32a838950ac0d48919
BLAKE2b-256 1e1b4b2ae2382bc4d7ea6bf5bcd4d9ff780a20f093a641e3e583dbf5cbd4fbc1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ansible_doctor-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 55bb4c5a8f9f557a3e3c301d5a727cdee556deaa423e4826690a52d579f35b7e
MD5 bbad76adf1c9f6b882866e712c60f0e9
BLAKE2b-256 ff30594e2fde3910b86b8c9bcccbbaf6257a90890069f29ab25e44bfb386c43a

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