github/ansible-doctor
0
0
Fork 0
mirror of https://github.com/thegeeklab/ansible-doctor.git synced 2024-11-16 10:10:39 +00:00
Code Issues Projects Releases Wiki Activity
8504e7f349
ansible-doctor/docs/content/_index.md
Robert Kaussow a37812031e fix license badge
2020-01-27 13:44:26 +01:00

1.6 KiB
Raw Blame History

title
Documentation

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 at GitHub or PyPI and as Docker Image at DockerHub.