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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ansible-doctor-0.2.2.tar.gz
Algorithm Hash digest
SHA256 04d3b8a1890ddc7148394846e85ba8b0935b520f1d7c126e915ffff2f8bd6d5d
MD5 d474f656bc9584bbd1302d1fd8c91106
BLAKE2b-256 bfd6555808d2ee7949351000173886378026885ddc68f08c18ede6b228ba6a7b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ansible_doctor-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2dec552ed693a4118db2261f944aea36a7ce08b6c8e70c350bb303aa8a53a49d
MD5 7a9a1daa260f1d29cd98cd6649599279
BLAKE2b-256 8cc7e07e89687ea37c1cd53a6c4490e4224ed62a41f3cc4b4f0fe73d473b2ebe

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