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
ansible-mdgen-0.0.20.tar.gz
(10.3 kB
view details)
Built Distribution
File details
Details for the file ansible-mdgen-0.0.20.tar.gz.
File metadata
- Download URL: ansible-mdgen-0.0.20.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 43680e19ef0ea4f036311aa663ff996cc1430f1d4bee1b8ceb2e904d3c10b7d8 |
|
| MD5 | 6b119d242d888bf6679736b5ddd45e99 |
|
| BLAKE2b-256 | 6f20e95c2998ff516f244f78fba5a0c2bf0c8a6c3d1c0aac6fb63c9f0a2dfc14 |
File details
Details for the file ansible_mdgen-0.0.20-py3-none-any.whl.
File metadata
- Download URL: ansible_mdgen-0.0.20-py3-none-any.whl
- Upload date:
- Size: 15.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ba9feb1eb625d4c5fc3ebd0c07d17175baafd58dc99a7a5ba4e339c08bcbd97e |
|
| MD5 | 46444431f2e34e2d7d1552cf933128d9 |
|
| BLAKE2b-256 | 7355d15816877b972777c28ca5c3574f663bfed57976603346d94144306366c8 |
