github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
651 Commits
2 Branches
55 Tags
1.9 MiB
Python 87.4%
Jinja 11.7%
Makefile 0.9%
 
 
 
main
remote-template-src
v2.0.2
v2.0.1
v2.0.0
v1.4.8
v1.4.7
v1.4.6
v1.4.5
v1.4.4
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.4
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.9
v1.1.8
v1.1.7
v1.1.6
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.10
v1.1.1
v1.1.0
v1.0.1
v1.0.0
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.7
v0.1.6
v0.1.5
v0.1.4
v0.1.3
v0.1.2
v0.1.1
v0.1.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
renovate[bot] 88fc60af80
chore(deps): lock file maintenance (#465) 		3 days ago
.chglog chore: adjust changelog template to link to prs instead of issues (#206) 1 year ago
.github [skip ci] adjust repo config 8 months ago
ansibledoctor chore: update comment from "Todo" to "Tag" for tag includes (#466) 3 weeks ago
docs feat: add option to run ansible-doctor recursively (#451) 1 month ago
example fix: fix map filter used for meta description (#457) 1 month ago
.dictionary feat: add pre-commit support (#449) 1 month ago
.drone.jsonnet ci: bump container build plugin to drone-docker-buildx:23 (#447) 1 month ago
.drone.yml ci: bump container build plugin to drone-docker-buildx:23 (#447) 1 month ago
.gitignore refctor: migrate flake8 to ruff python linter (#429) 2 months ago
.markdownlint.yml fix: join lines with newline instead of space in markdown templates (#446) 1 month ago
.pre-commit-hooks.yaml feat: add pre-commit support (#449) 1 month ago
.prettierignore chore: end of the year maintenance 1 year ago
CONTRIBUTING.md docs: add contributing information 2 years ago
Dockerfile.multiarch chore(docker): update python:3.11-alpine docker digest to 741e650 1 week ago
LICENSE chore: end of the year maintenance 1 year ago
Makefile chore(deps): update dependency thegeeklab/hugo-geekdoc to v0.38.0 3 weeks ago
README.md docs: fix spelling in readme 8 months ago
poetry.lock chore(deps): lock file maintenance (#465) 3 days ago
pyproject.toml fix(deps): update dependency pathspec to v0.11.1 (#472) 3 days ago
renovate.json chore: use renovate preset config 2 years ago

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.