github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
689 Commits 2 Branches 72 Tags 3.1 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
renovate[bot] 584e212f52 chore(deps): update devdeps non-major 2023-06-19 03:32:23 +00: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 feat: add vars `deprecated` and `type` scope to built-in templates (#509) 2023-06-14 16:47:44 +02:00
docs feat: add support for indentation with spaces (#508) 2023-06-14 13:31:01 +02:00
example feat: add vars `deprecated` and `type` scope to built-in templates (#509) 2023-06-14 16:47:44 +02:00
.dictionary feat: add pre-commit support (#449) 2023-02-10 19:56:00 +01:00
.drone.jsonnet chore: remove poetry experimental.new-installer flag (#497) 2023-05-28 15:18:33 +02:00
.drone.yml chore: remove poetry experimental.new-installer flag (#497) 2023-05-28 15:18:33 +02: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 fix bare url in contribution file (#488) 2023-05-03 09:31:07 +02:00
Dockerfile.multiarch chore(docker): update python:3.11-alpine docker digest to 25df32b 2023-06-15 20:31:29 +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.39.4 2023-06-09 10:40:13 +00:00
README.md docs: fix spelling in readme 2022-07-15 08:50:06 +02:00
poetry.lock chore(deps): update devdeps non-major 2023-06-19 03:32:23 +00:00
pyproject.toml chore(deps): update devdeps non-major 2023-06-19 03:32:23 +00: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.