Generate documentation from annotated Ansible roles using templates.
Project description
ansible-doctor
Annotation based documentation for your Ansible roles
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.
Contributors
Special thanks goes 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size ansible_doctor-0.2.1-py3-none-any.whl (41.6 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
| Filename, size ansible-doctor-0.2.1.tar.gz (26.0 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for ansible_doctor-0.2.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5e35e287ca14839d2e80d69b912625cb8596e2bee6c92c4205a9dec3c9d5186d |
|
| MD5 | 0ec7ca7b8c2ab65d6aef2b2cf90083a4 |
|
| BLAKE2-256 | a6d3ff1d56dc19178de90c2a968e913c13e6c95d014465449dd7972829ff9381 |
