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 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.
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.
Source Distribution
Built Distribution
File details
Details for the file ansible_doctor-4.0.0.tar.gz.
File metadata
- Download URL: ansible_doctor-4.0.0.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/5.15.0-89-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c81885d184bb2c31aec0c7bf87de5b91f7dbfdbf238d828289d5eb963f9d5e6e |
|
| MD5 | 2576ccbcaebab66733e6b5194c0ee23b |
|
| BLAKE2b-256 | 3f291c9afa3d243648ad5818b9c2812191b7bf632d2e04d3ead3c7179b5ca8d8 |
File details
Details for the file ansible_doctor-4.0.0-py3-none-any.whl.
File metadata
- Download URL: ansible_doctor-4.0.0-py3-none-any.whl
- Upload date:
- Size: 46.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/5.15.0-89-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f9f2de4d3f2a1a33187dac890df19f7b068ed1f98a7fcb4aa0731c05401ee49 |
|
| MD5 | c0bf7ab73a1df01b509ef013e3987b44 |
|
| BLAKE2b-256 | 241590c42554f03d5a2b1e39165c0703cc94b7bc69f6ae98e26e8fa557c60d9d |
