github/ansible-doctor
0
0
Fork 0
mirror of https://github.com/thegeeklab/ansible-doctor.git synced 2024-11-17 18:50:41 +00:00
Code Issues Projects Releases Wiki Activity
904 Commits 1 Branch 79 Tags 3.7 MiB
Python 78.6%
Jinja 20.5%
Makefile 0.9%
c9066fe6be
Go to file
renovate[bot] c9066fe6be
chore(docker): update python:3.12-alpine docker digest to 0bd77ae (#735) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| python | final | digest | `29d92b7` -> `0bd77ae` |

---

### Configuration

📅 **Schedule**: Branch creation - "before 4am" (UTC), Automerge - At any
time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/thegeeklab/ansible-doctor).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjUuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyNS4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-07-11 05:51:52 +02:00
.github use list style synatx and cleanup (#619) 2023-12-23 23:24:56 +01:00
.gitsv chore: replace git-chglog by git-sv (#574) 2023-10-16 15:43:04 +02:00
.woodpecker chore(deps): update quay.io/thegeeklab/wp-docker-buildx docker tag to v5 (#733) 2024-07-08 21:52:04 +02:00
ansibledoctor fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
docs fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
example feat: add option to load templates from remote git sources (#717) 2024-06-12 20:59:55 +02:00
.dictionary fix: fix syntax issue in annotation parser (#725) 2024-06-22 20:49:16 +02:00
.gitignore refctor: migrate flake8 to ruff python linter (#429) 2023-01-20 11:56:12 +01:00
.lycheeignore ci: exclude dockerhub from linkcheck due to rate limiting 2023-12-07 09:08:22 +01:00
.markdownlint.yml chore: unifi jinja template syntax and add linting (#704) 2024-06-02 09:00:07 +02:00
.pre-commit-hooks.yaml fix: install extra group when using pre-commit (#687) 2024-04-24 08:54:48 +02:00
.prettierignore ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
Containerfile.multiarch chore(docker): update python:3.12-alpine docker digest to 0bd77ae (#735) 2024-07-11 05:51:52 +02:00
CONTRIBUTING.md fix bare url in contribution file (#488) 2023-05-03 09:31:07 +02: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.46.0 2024-06-10 03:08:33 +02:00
poetry.lock chore(deps): lock file maintenance (#728) 2024-07-08 09:10:36 +02:00
pyproject.toml chore(deps): update dependency ruff to v0.5.1 (#732) 2024-07-08 03:53:11 +02:00
README.md ci: migrate to woodpecker (#543) 2023-08-25 00:02:01 +02:00
renovate.json separate minor-patch for ansible deps 2024-04-12 09:23:00 +02: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.