Metadata-Version: 2.1
Name: ansible-mdgen
Version: 0.1.0
Summary: A python package to automate documentation generation for ansible roles.
Home-page: https://github.com/murphypetercl/ansible-mdgen
Author: Peter Murphy
Author-email: murphy.petercl@gmail.com
License: UNKNOWN
Description: # ansible-mdgen
        
        [![<CircleCI>](https://circleci.com/gh/murphypetercl/ansible-mdgen.svg?style=svg)](https://app.circleci.com/pipelines/github/murphypetercl/ansible-mdgen?branch=main)
        
        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](https://murphypetercl.github.io/ansible-mdgen/) for full documentation.
        
        ## Credits
        
        The idea for this project is based on (and includes some code from) [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credit to him for his work.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
