github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
182 Commits 3 Branches 71 Tags 3 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
Robert Kaussow 2981079cbf
docs: add contributing information 		2020-12-31 13:43:28 +01:00
.github migrate to thegeeklab namespace 2020-09-27 14:21:54 +02:00
ansibledoctor migrate to thegeeklab namespace 2020-09-27 14:21:54 +02:00
bin fork; initial commit 2019-10-07 08:52:00 +02:00
docker chore(docker): switch to org.opencontainers image labels 2020-12-31 13:40:10 +01:00
docs remove duplicate badge 2020-10-23 13:19:07 +02:00
example migrate to thegeeklab namespace 2020-09-27 14:21:54 +02:00
.dictionary disable spellchecker for 'highlight' shortcodes 2020-06-07 16:29:44 +02:00
.drone.jsonnet fix dockerfile names in ci config 2020-12-31 13:41:26 +01:00
.drone.yml fix dockerfile names in ci config 2020-12-31 13:41:26 +01:00
.flake8 add yapf as formatter 2020-04-05 23:16:53 +02:00
.gitignore add docs 2020-01-16 11:27:46 +01:00
.markdownlint.yml fix docs formatting 2020-06-03 16:22:56 +02:00
CHANGELOG.md migrate to thegeeklab namespace 2020-09-27 14:21:54 +02:00
CONTRIBUTING.md docs: add contributing information 2020-12-31 13:43:28 +01:00
LICENSE migrate to thegeeklab namespace 2020-09-27 14:21:54 +02:00
MANIFEST.in include static package data in wheel 2019-10-09 11:52:01 +02:00
Makefile Update dependency thegeeklab/hugo-geekdoc to v0.8.1 2020-12-23 17:11:28 +00:00
README.md docs: add contributing information 2020-12-31 13:43:28 +01:00
dev-requirements.txt remove version pinning for pydocstyle 2020-11-12 22:41:07 +01:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +01:00
setup.cfg rename test folder 2020-04-06 00:23:42 +02:00
setup.py add python 3.9 support 2020-11-12 22:10:27 +01:00

README.md

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 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 Docker Hub.

You can find the full documentation 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.