Go to file
Robert Kaussow ce0cd8a7e6
feat: add option exclude_tags to disable auto-discovery (#289)
2022-04-29 13:19:35 +02: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 feat: add option exclude_tags to disable auto-discovery (#289) 2022-04-29 13:19:35 +02:00
docker chore(docker): update docker digests to 032fd45 2022-04-20 20:40:41 +00:00
docs feat: add option exclude_tags to disable auto-discovery (#289) 2022-04-29 13:19:35 +02:00
example feat: add option exclude_tags to disable auto-discovery (#289) 2022-04-29 13:19:35 +02:00
.dictionary feat: implement todo identifiers (#246) 2022-02-21 21:38:47 +01:00
.drone.jsonnet ci: update hugo to v0.93.2 2022-03-05 16:57:00 +01:00
.drone.yml ci: update hugo to v0.93.2 2022-03-05 16:57:00 +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.29.1 2022-04-28 13:56:10 +00:00
README.md feat: implement todo identifiers (#246) 2022-02-21 21:38:47 +01:00
poetry.lock chore(deps): lock file maintenance (#278) 2022-04-29 12:23:59 +02:00
pyproject.toml fix(deps): update dependency jinja2 to v3.1.2 (#288) 2022-04-29 12:23:50 +02:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +01:00
setup.cfg chore: adjust yapf dict formatting to avoid line breaks (#273) 2022-04-04 22:27:37 +02: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 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.