Go to file
2022-01-09 21:46:55 +01:00
.chglog chore: adjust changelog template to link to prs instead of issues (#206) 2021-12-12 14:32:30 +01:00
.github [skip ci] fix github settings syntax 2021-05-25 18:01:02 +02:00
ansibledoctor fix: fix format string of the json logger (#181) 2021-10-07 22:59:43 +02:00
docker chore: add build deps to Dockerfile (#220) 2022-01-09 21:46:55 +01:00
docs docs: add documentation for new option role_detection 2021-07-27 22:09:13 +02:00
example fix ci badge 2021-01-17 15:23:46 +01:00
.dictionary disable spellchecker for 'highlight' shortcodes 2020-06-07 16:29:44 +02:00
.drone.jsonnet chore: end of the year maintenance 2021-12-21 10:15:38 +01:00
.drone.yml sign drone config 2021-12-21 10:24:53 +01:00
.gitignore ci: auto-generate changelog (#66) 2021-03-23 21:10:04 +01:00
.markdownlint.yml fix docs formatting 2020-06-03 16:22:56 +02:00
.prettierignore chore: end of the year maintenance 2021-12-21 10:15:38 +01:00
CONTRIBUTING.md docs: add contributing information 2020-12-31 13:43:28 +01:00
LICENSE chore: end of the year maintenance 2021-12-21 10:15:38 +01:00
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.22.2 2022-01-08 23:26:21 +00:00
poetry.lock chore(deps): lock file maintenance (#210) 2022-01-08 12:55:32 +01:00
pyproject.toml fix(deps): update dependency environs to v9.4.0 (#215) 2022-01-07 16:19:32 +01:00
README.md fix ci badge 2021-01-17 15:23:46 +01:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +01:00
setup.cfg chore: disable rule D105 in flake 2021-06-09 20:57:19 +02:00

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.