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] 4fc1e52c4a chore(deps): update dependency flake8-logging-format to v0.9.0 2 days ago
.chglog chore: adjust changelog template to link to prs instead of issues (#206) 12 months ago
.github [skip ci] adjust repo config 4 months ago
ansibledoctor chore(deps): update devdependencies (non-major) (#354) 3 months ago
docker chore(docker): update docker digests 2 weeks ago
docs docs: fix hugo hint shortcode 7 months ago
example fix: get role name from dependencies in case of a dictionary (#300) 7 months ago
.dictionary fix spellcheck 4 months ago
.drone.jsonnet ci: use python311 base image on ci (#409) 5 days ago
.drone.yml ci: use python311 base image on ci (#409) 5 days ago
.gitignore ci: switch to linkchecker (#302) 6 months ago
.markdownlint.yml fix docs formatting 3 years ago
.prettierignore chore: end of the year maintenance 11 months ago
CONTRIBUTING.md docs: add contributing information 2 years ago
LICENSE chore: end of the year maintenance 11 months ago
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.36.1 2 weeks ago
README.md docs: fix spelling in readme 5 months ago
poetry.lock chore(deps): update dependency flake8-logging-format to v0.9.0 2 days ago
pyproject.toml chore(deps): update dependency flake8-logging-format to v0.9.0 2 days ago
renovate.json chore: use renovate preset config 2 years ago
setup.cfg chore(deps): update devdependencies (non-major) (#354) 3 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 custom templates to customize the output or render the data to other formats like HTML or XML as well.

ansible-doctor is designed to work within a CI pipeline to complete the existing testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.

The full documentation is available at https://ansible-doctor.geekdocs.de.

Contributors

Special thanks 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.