Skip to main content

Generate documentation from annotated Ansible roles using templates

Project description

ansible-doctor

Build Status Docker Hub Python Version PyPi Status PyPi Release License: MIT

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 DockerHub.

You can find the full documentation at https://ansible-doctor.geekdocs.de.

License

This project is licensed under the GNU v3.0 - see the LICENSE file for details.

Maintainers and Contributors

Robert Kaussow

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

Uploaded Source

Built Distribution

ansible_doctor-0.1.5-py2.py3-none-any.whl (30.7 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: ansible-doctor-0.1.5.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for ansible-doctor-0.1.5.tar.gz
Algorithm Hash digest
SHA256 5602f1b2c534ce91c21e2759f2299963cbc0e3450798b70a45259b3af28beeae
MD5 449240528e9b8f05f3ce443ae2067bf8
BLAKE2b-256 dc776e27a92be3f472536b80c4122e27c142c6a2118384d82b048c12a1880611

See more details on using hashes here.

File details

Details for the file ansible_doctor-0.1.5-py2.py3-none-any.whl.

File metadata

  • Download URL: ansible_doctor-0.1.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 30.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for ansible_doctor-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 74f130ae83b0d969886f68306fe8ee0c41687b592b36a878b46bd50113bad5bf
MD5 a95c24a6c3da8760d8ada11e3637f864
BLAKE2b-256 cb43d50dbb5768a6e65a9d06b0aa3e2d4777aba6301f3650d0f3d557b4aaf300

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