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

Uploaded Source

Built Distribution

ansible_doctor-1.2.0-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-1.2.0.tar.gz
  • Upload date:
  • Size: 26.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.4.0-96-generic

File hashes

Hashes for ansible-doctor-1.2.0.tar.gz
Algorithm Hash digest
SHA256 089b232eb7bb1202656eeef35d36ae970f86020f477c3e020bd9d297b3b76eb8
MD5 cbfdae55aaba89070fb4ae530f50bc0a
BLAKE2b-256 41da7aea3385360c09a921368ac3f9226b3422fc7fa348b66180b2c59098177c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Linux/5.4.0-96-generic

File hashes

Hashes for ansible_doctor-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5d4fed79cb5ebd00f7c32d6141a42916c42f507f48cdcd4bca6db11eb8138dc1
MD5 b45ac044ddf5f324a2998035039cc335
BLAKE2b-256 7ca1899b6eb1cb7a04756add722826cb083d5c4303bb4df074b3e86277de750b

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