github
/
ansible-doctor
mirror of https://github.com/thegeeklab/ansible-doctor.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
137 Commits 3 Branches 72 Tags 3.1 MiB
Python 84.9%
Jinja 14.2%
Makefile 0.9%
Go to file
Robert Kaussow a5b3eab603 fix docs formatting 2020-06-03 16:22:56 +02:00
.github add yapf as formatter 2020-04-05 23:16:53 +02:00
ansibledoctor remove underscore replacement 2020-05-25 20:26:12 +02:00
bin fork; initial commit 2019-10-07 08:52:00 +02:00
docs fix docs formatting 2020-06-03 16:22:56 +02:00
example use an explicit marker symbol to value2json conversion 2019-10-15 09:54:03 +02:00
.dictionary fix docs formatting 2020-06-03 16:22:56 +02:00
.drone.jsonnet fix hugo base dir 2020-06-03 12:24:17 +02:00
.drone.yml fix hugo base dir 2020-06-03 12:24:17 +02:00
.flake8 add yapf as formatter 2020-04-05 23:16:53 +02:00
.gitignore add docs 2020-01-16 11:27:46 +01:00
.markdownlint.yml fix docs formatting 2020-06-03 16:22:56 +02:00
CHANGELOG.md add docs validation to ci 2020-06-02 22:17:46 +02:00
Dockerfile cleanup 2020-04-11 13:34:30 +02:00
LICENSE [SKIP CI] update license 2020-02-24 23:10:27 +01:00
MANIFEST.in include static package data in wheel 2019-10-09 11:52:01 +02:00
README.md add docs validation to ci 2020-06-02 22:17:46 +02:00
dev-requirements.txt add flake8-pep3101 2020-04-11 14:00:54 +02:00
manifest.tmpl cleanup 2019-10-09 13:03:55 +02:00
setup.cfg rename test folder 2020-04-06 00:23:42 +02:00
setup.py use glob to install wheel 2020-04-11 13:25:56 +02:00

README.md

ansible-doctor

Build Status Docker Hub Python Version PyPI Status PyPI Release License: MIT

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 your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. HTML or XML).

ansible-doctor is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.

You can find the full documentation at https://ansible-doctor.geekdocs.de.

License

This project is licensed under the GNU v3.0 - see the LICENSE file for details.

Maintainers and Contributors

Robert Kaussow