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.
 
 
 
Robert Kaussow 22b7315139
chore: remove dev dependency flake8-colors (#77)
20 hours ago
.chglog ci: auto-generate changelog (#66) 3 weeks ago
.github [skip ci] disable github strict status check 2 months ago
ansibledoctor refactor: rename modules to reflect pep8 recommendations (#27) 3 months ago
docker chore(deps): update arm64v8/python:3.9-alpine docker digest to 0a685ca 1 week ago
docs docs: fix icons in more menu 1 month ago
example fix ci badge 3 months ago
.dictionary disable spellchecker for 'highlight' shortcodes 10 months ago
.drone.jsonnet ci: auto-generate changelog (#66) 3 weeks ago
.drone.yml ci: auto-generate changelog (#66) 3 weeks ago
.gitignore ci: auto-generate changelog (#66) 3 weeks ago
.markdownlint.yml fix docs formatting 10 months ago
CONTRIBUTING.md docs: add contributing information 3 months ago
LICENSE [skip ci] update year in license file 3 months ago
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.11.0 1 day ago
README.md fix ci badge 3 months ago
poetry.lock chore: remove dev dependency flake8-colors (#77) 20 hours ago
pyproject.toml chore: remove dev dependency flake8-colors (#77) 20 hours ago
renovate.json chore: use renovate preset config 3 months ago
setup.cfg chore: remove dev dependency flake8-colors (#77) 20 hours 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 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.