github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
659 Commits 2 Branches 72 Tags 3.1 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
Robert Kaussow 596b27e696
fix: fix formatting of meta.license.value in readme template (#479) 		2023-04-05 14:08:36 +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] adjust repo config 2022-07-21 09:50:57 +02:00
ansibledoctor fix: fix formatting of meta.license.value in readme template (#479) 2023-04-05 14:08:36 +02:00
docs fix docs for vars multiline example 2023-03-27 13:22:46 +02:00
example fix: fix map filter used for meta description (#457) 2023-02-16 20:55:31 +01:00
.dictionary feat: add pre-commit support (#449) 2023-02-10 19:56:00 +01:00
.drone.jsonnet ci: bump container build plugin to drone-docker-buildx:23 (#447) 2023-02-09 19:40:49 +01:00
.drone.yml ci: bump container build plugin to drone-docker-buildx:23 (#447) 2023-02-09 19:40:49 +01:00
.gitignore refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
.markdownlint.yml fix: join lines with newline instead of space in markdown templates (#446) 2023-02-09 19:27:22 +01:00
.pre-commit-hooks.yaml feat: add pre-commit support (#449) 2023-02-10 19:56:00 +01: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 4b4078a 2023-03-30 06:57:44 +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.38.1 2023-03-27 22:58:26 +00:00
README.md docs: fix spelling in readme 2022-07-15 08:50:06 +02:00
poetry.lock chore(deps): lock file maintenance (#465) 2023-03-20 10:36:27 +01:00
pyproject.toml fix(deps): update dependency pathspec to v0.11.1 (#472) 2023-03-20 10:34:42 +01:00
renovate.json chore: use renovate preset config 2020-12-31 13:33:55 +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.