ansible-doctor/README.md

27 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2019-10-07 06:52:00 +00:00
# ansible-doctor
2020-09-05 16:01:56 +00:00
ansible-doctor - Simple annotation based documentation for your roles
2020-01-27 12:41:29 +00:00
[![Build Status](https://img.shields.io/drone/build/xoxys/ansible-doctor?logo=drone)](https://cloud.drone.io/xoxys/ansible-doctor)
[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/ansible-doctor)
[![Python Version](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
2020-06-02 20:17:46 +00:00
[![PyPI Status](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
[![PyPI Release](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
2020-01-27 12:44:26 +00:00
[![License: MIT](https://img.shields.io/github/license/xoxys/ansible-doctor)](LICENSE)
2019-10-10 12:59:12 +00:00
This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work.
2020-06-02 20:17:46 +00:00
_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).
2019-10-10 12:59:12 +00:00
2020-06-02 20:17:46 +00:00
_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](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/xoxys/ansible-doctor).
2019-10-10 12:59:12 +00:00
2020-01-27 12:41:29 +00:00
You can find the full documentation at [https://ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/).
2019-10-10 12:59:12 +00:00
2020-02-24 21:17:09 +00:00
## License
2019-10-10 12:59:12 +00:00
This project is licensed under the GNU v3.0 - see the [LICENSE](https://github.com/xoxys/ansible-doctor/blob/master/LICENSE) file for details.
2020-02-24 21:17:09 +00:00
## Maintainers and Contributors
2019-10-10 12:59:12 +00:00
[Robert Kaussow](https://github.com/xoxys)