Go to file
renovate[bot] 14a8ea2f1c
fix(deps): update dependency anyconfig to ^0.10.0 (#29)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-01-04 15:48:24 +01:00
.github chore: replace master by main as default branch 2020-12-31 14:53:39 +01:00
ansibledoctor refactor: rename modules to reflect pep8 recommendations (#27) 2021-01-01 13:50:41 +01:00
docker chore(deps): pin docker digests 2020-12-31 13:36:55 +00:00
docs chore: replace master by main as default branch 2020-12-31 14:53:39 +01:00
example fix outdated badges in demo-role 2020-12-31 15:06:20 +01:00
.dictionary disable spellchecker for 'highlight' shortcodes 2020-06-07 16:29:44 +02:00
.drone.jsonnet use hugo 0.80 in ci 2021-01-03 22:05:30 +01:00
.drone.yml use hugo 0.80 in ci 2021-01-03 22:05:30 +01:00
.flake8 chore(devel): merge flake8 and yapf config into setup.cfg (#28) 2021-01-01 14:36:42 +01:00
.gitignore add docs 2020-01-16 11:27:46 +01:00
.markdownlint.yml fix docs formatting 2020-06-03 16:22:56 +02:00
CHANGELOG.md [skip ci]: update changelog 2020-12-31 16:30:11 +01:00
CONTRIBUTING.md docs: add contributing information 2020-12-31 13:43:28 +01:00
LICENSE [skip ci] update year in license file 2021-01-03 21:40:25 +01:00
Makefile Update dependency thegeeklab/hugo-geekdoc to v0.8.1 2020-12-23 17:11:28 +00:00
poetry.lock fix(deps): update dependency anyconfig to ^0.10.0 (#29) 2021-01-04 15:48:24 +01:00
pyproject.toml fix(deps): update dependency anyconfig to ^0.10.0 (#29) 2021-01-04 15:48:24 +01:00
README.md chore: replace master by main as default branch 2020-12-31 14:53:39 +01:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +01:00
setup.cfg chore(devel): merge flake8 and yapf config into setup.cfg (#28) 2021-01-01 14:36:42 +01: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.