github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
615 Commits 2 Branches 72 Tags 3.2 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
renovate[bot] 9df909e8a1
chore(deps): lock file maintenance (#427) 		2023-01-20 12:08:17 +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] adjust repo config 2022-07-21 09:50:57 +02:00
ansibledoctor refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
docs docs: fix hugo hint shortcode 2022-05-02 21:51:51 +02:00
example fix: get role name from dependencies in case of a dictionary (#300) 2022-05-17 14:19:31 +02:00
.dictionary fix spellcheck 2022-07-25 09:59:24 +02:00
.drone.jsonnet refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
.drone.yml refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
.gitignore refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +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
Dockerfile.multiarch chore(docker): update python:3.11-alpine docker digest to 625383c 2023-01-18 14:15:07 +00: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.37.1 2022-12-21 20:50:09 +00:00
README.md docs: fix spelling in readme 2022-07-15 08:50:06 +02:00
poetry.lock chore(deps): lock file maintenance (#427) 2023-01-20 12:08:17 +01:00
pyproject.toml refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +01:00
setup.cfg refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01: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 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.