Skip to main content

A python package to automate documentation generation for ansible roles.

Project description

ansible-mdgen

<CircleCI>

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.

Project details


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.1.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

ansible_mdgen-0.1.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file ansible-mdgen-0.1.0.tar.gz.

File metadata

  • Download URL: ansible-mdgen-0.1.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for ansible-mdgen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 dc8e65406cf4c82a3dcc9fed0166f6fdea7c23f07e78500161fb04445589b257
MD5 94b8e9000c197390f0e52fdd4704744f
BLAKE2b-256 cf1df1fb3be32953a27f4ebfceb31c72fbe744979d8ddad1417ec57aa753bee8

See more details on using hashes here.

File details

Details for the file ansible_mdgen-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ansible_mdgen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.9.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for ansible_mdgen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66c6ce6677d96b85e11dacee87983cf7cf3829bbcbde358e1fca8c8884c283ab
MD5 c84f5d3326747270c479682d65881965
BLAKE2b-256 2a4ba6ffe691b9b425f604b4e18083555804649fe045843174c22dc82ea205e8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page