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 ddb186322c chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.30.1 1 day ago
.chglog chore: adjust changelog template to link to prs instead of issues (#206) 5 months ago
.github [skip ci] fix github settings syntax 1 year ago
ansibledoctor fix: get role name from dependencies in case of a dictionary (#300) 1 week ago
docker chore(docker): update docker digests to b1c7b16 1 week ago
docs docs: fix hugo hint shortcode 3 weeks ago
example fix: get role name from dependencies in case of a dictionary (#300) 1 week ago
.dictionary feat: implement todo identifiers (#246) 3 months ago
.drone.jsonnet ci: switch to linkchecker (#302) 5 days ago
.drone.yml ci: switch to linkchecker (#302) 5 days ago
.gitignore ci: switch to linkchecker (#302) 5 days ago
.linkcheckignore ci: switch to linkchecker (#302) 5 days ago
.markdownlint.yml fix docs formatting 2 years ago
.prettierignore chore: end of the year maintenance 5 months ago
CONTRIBUTING.md docs: add contributing information 1 year ago
LICENSE chore: end of the year maintenance 5 months ago
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.30.1 1 day ago
README.md feat: implement todo identifiers (#246) 3 months ago
poetry.lock chore(deps): lock file maintenance (#296) 5 days ago
pyproject.toml fix(deps): update dependency jsonschema to v4.5.1 (#294) 3 weeks ago
renovate.json chore: use renovate preset config 1 year ago
setup.cfg chore: adjust yapf dict formatting to avoid line breaks (#273) 2 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 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.