github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
782 Commits 2 Branches 72 Tags 3.1 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
dependabot[bot] 41ed10270d
chore(deps): bump cryptography from 41.0.5 to 41.0.6 (#609) 
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 		2023-12-05 10:16:25 +01:00
.github fix settings for required status checks 2023-12-04 21:01:49 +01:00
.gitsv chore: replace git-chglog by git-sv (#574) 2023-10-16 15:43:04 +02:00
.woodpecker chore: drop yapf and favor of the ruff formatter (#595) 2023-11-10 14:50:50 +01:00
ansibledoctor fix: replace log by message for yes/no prompt (#606) 2023-11-23 10:33:36 +01:00
docs docs: remove broken galaxy link (#561) 2023-10-02 12:59:05 +02:00
example fix: parse taskfiles as ansible tasks (#597) 2023-11-12 21:39:41 +01:00
.dictionary feat: add pre-commit support (#449) 2023-02-10 19:56:00 +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 chore: disable logging in pre-commit (#600) 2023-11-15 08:25:54 +01:00
.prettierignore ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
CONTRIBUTING.md fix bare url in contribution file (#488) 2023-05-03 09:31:07 +02:00
Containerfile.multiarch chore(docker): update python:3.12-alpine docker digest to 09f18c1 2023-12-04 20:02:12 +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.44.0 2023-10-28 23:33:07 +02:00
README.md ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
poetry.lock chore(deps): bump cryptography from 41.0.5 to 41.0.6 (#609) 2023-12-05 10:16:25 +01:00
pyproject.toml fix(deps): update dependency jsonschema to v4.20.0 (#601) 2023-11-20 09:00:46 +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.