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.16.tar.gz
(10.1 kB
view details)
Built Distribution
File details
Details for the file ansible-mdgen-0.0.16.tar.gz.
File metadata
- Download URL: ansible-mdgen-0.0.16.tar.gz
- Upload date:
- Size: 10.1 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.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 72bbd51c68f24130cd0c6361c1189c8395988f19aaf7e37e195a8b5eed52cc14 |
|
| MD5 | 5b4fac948977b48997d5f76036c2d868 |
|
| BLAKE2b-256 | d16c2190e31fb0199a3d7e05c51f20a913e42ea9d511a341b12dd9e66146f467 |
File details
Details for the file ansible_mdgen-0.0.16-py3-none-any.whl.
File metadata
- Download URL: ansible_mdgen-0.0.16-py3-none-any.whl
- Upload date:
- Size: 15.5 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.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f5c0c1d3ed65466899b213a7c82305bc19ab49715a1eae290745494f21628861 |
|
| MD5 | 7a27ba84cb126f1e52eaf72ad5467a8e |
|
| BLAKE2b-256 | 326522a4ced56c846dba501f0162fd193328ab5c7c07a035326c846b1149ccd9 |
