You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Renovate Bot c8bcfccbec chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.23.0 6 days ago
.chglog chore: adjust changelog template to link to prs instead of issues (#206) 1 month ago
.github [skip ci] fix github settings syntax 8 months ago
ansibledoctor fix: fix format string of the json logger (#181) 3 months ago
docker chore: add build deps to Dockerfile (#220) 1 week ago
docs docs: add documentation for new option role_detection 6 months ago
example fix ci badge 1 year ago
.dictionary disable spellchecker for 'highlight' shortcodes 2 years ago
.drone.jsonnet chore: end of the year maintenance 4 weeks ago
.drone.yml sign drone config 4 weeks ago
.gitignore ci: auto-generate changelog (#66) 10 months ago
.markdownlint.yml fix docs formatting 2 years ago
.prettierignore chore: end of the year maintenance 4 weeks ago
CONTRIBUTING.md docs: add contributing information 1 year ago
LICENSE chore: end of the year maintenance 4 weeks ago
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.23.0 6 days ago
README.md fix ci badge 1 year ago
poetry.lock fix(deps): update dependency ruamel.yaml to v0.17.20 (#212) 1 week ago
pyproject.toml fix(deps): update dependency ruamel.yaml to v0.17.20 (#212) 1 week ago
renovate.json chore: use renovate preset config 1 year ago
setup.cfg chore: disable rule D105 in flake 7 months ago

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.