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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.1.6.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Linux/5.4.0-90-generic

File hashes

Hashes for ansible-doctor-1.1.6.tar.gz
Algorithm Hash digest
SHA256 19ed6375a1f46e199982df8bd69a11596a9331831c28dfeebf75f09c5d888339
MD5 dc522aa34afe0a0f85cf6bd030e72e7d
BLAKE2b-256 d20041ae348798a0a549061bb948aafef173a60bcf05c807e310b34946e1a961

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ansible_doctor-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5162db3fb916e53b956f426051189d5b0c6891120b3d6f00ccf388fc6731c79d
MD5 ca09ef099b95e3d39827ed24449c2497
BLAKE2b-256 e00c525a7d01a5a3f136da67c362bff0db818fd8d14cc1e91270f2a7de2aa423

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