github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
89 Commits 2 Branches 72 Tags 3.2 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
Robert Kaussow ac524698d2 update docs and readme 2020-01-27 13:41:29 +01:00
ansibledoctor fix failed loading of empty yaml files 2020-01-27 11:03:37 +01:00
bin fork; initial commit 2019-10-07 08:52:00 +02:00
docs update docs and readme 2020-01-27 13:41:29 +01:00
example use an explicit marker symbol to value2json conversion 2019-10-15 09:54:03 +02:00
.drone.jsonnet update docs and readme 2020-01-27 13:41:29 +01:00
.drone.yml update docs and readme 2020-01-27 13:41:29 +01:00
.flake8 fork; initial commit 2019-10-07 08:52:00 +02:00
.gitignore add docs 2020-01-16 11:27:46 +01:00
CHANGELOG.md fix failed loading of empty yaml files 2020-01-27 11:03:37 +01:00
Dockerfile enable PY_COLORS in docker image by default 2019-10-16 07:59:45 +02:00
LICENSE switch license to GPL 2019-10-08 12:04:39 +02:00
MANIFEST.in include static package data in wheel 2019-10-09 11:52:01 +02:00
README.md update docs and readme 2020-01-27 13:41:29 +01:00
manifest.tmpl cleanup 2019-10-09 13:03:55 +02:00
setup.cfg fork; initial commit 2019-10-07 08:52:00 +02:00
setup.py fully migrate to ruamel.yaml instead of pyyaml 2019-10-15 10:48:18 +02:00
test-requirements.txt fork; initial commit 2019-10-07 08:52:00 +02:00

README.md

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