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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ansible-doctor, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size ansible_doctor-0.1.5-py2.py3-none-any.whl (30.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size ansible-doctor-0.1.5.tar.gz (25.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page