A python package to automate documentation generation for ansible roles.
Project description
ansible-mdgen
Ansible-mdgen is a package used to auto generate documentation for an ansible role.
To install
pip install ansible-mdgen
To run
Call ansible-mdgen passing in the path to the role
ansible-mdgen <path_to_role>
Documentation
See here for full documentation.
Credits
The idea for this project is based on (and includes some code from) ansible-autodoc by Andres Bott so credit to him for his work.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ansible-mdgen-0.1.1.tar.gz.
File metadata
- Download URL: ansible-mdgen-0.1.1.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
38a3861de6bb8af149753ad0f0fa64f87089d4b644501d04596349ae32e0a783
|
|
| MD5 |
168a66b7c77c57c68f3f0317388a2af3
|
|
| BLAKE2b-256 |
55050d1ad362ea6322933446e2c88b256a1494161bb458b2ee963e28957b6e04
|
File details
Details for the file ansible_mdgen-0.1.1-py3-none-any.whl.
File metadata
- Download URL: ansible_mdgen-0.1.1-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.8.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
23ee7ec271b83a7d07ba1f32fc05acb4054b7539ed3d3b71090904dd7327ba0a
|
|
| MD5 |
31513c19979a8c2fd50ad3bdb0cab235
|
|
| BLAKE2b-256 |
fc3756c0c93eb5318b0dd302fbc7f18281cd9a05c92d826b9f1dc2ead97066cb
|
