ansible-mdgen

Name	ansible-mdgen JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/murphypetercl/ansible-mdgen
Summary	A python package to automate documentation generation for ansible roles.
upload_time	2023-11-14 12:42:52
maintainer
docs_url	None
author	Peter Murphy
requires_python	>=3.6
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/murphypetercl/ansible-mdgen",
    "name": "ansible-mdgen",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Peter Murphy",
    "author_email": "murphy.petercl@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/55/05/0d1ad362ea6322933446e2c88b256a1494161bb458b2ee963e28957b6e04/ansible-mdgen-0.1.1.tar.gz",
    "platform": null,
    "description": "# ansible-mdgen\n\n[![<CircleCI>](https://circleci.com/gh/murphypetercl/ansible-mdgen.svg?style=svg)](https://app.circleci.com/pipelines/github/murphypetercl/ansible-mdgen?branch=main)\n\nAnsible-mdgen is a package used to auto generate documentation for an ansible role.\n\n## To install\n```\npip install ansible-mdgen\n```\n\n\n## To run\n\nCall ansible-mdgen passing in the path to the role\n```\nansible-mdgen <path_to_role>\n```\n\n## Documentation\n\nSee [here](https://murphypetercl.github.io/ansible-mdgen/) for full documentation.\n\n## Credits\n\nThe 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.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A python package to automate documentation generation for ansible roles.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/murphypetercl/ansible-mdgen"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc3756c0c93eb5318b0dd302fbc7f18281cd9a05c92d826b9f1dc2ead97066cb",
                "md5": "31513c19979a8c2fd50ad3bdb0cab235",
                "sha256": "23ee7ec271b83a7d07ba1f32fc05acb4054b7539ed3d3b71090904dd7327ba0a"
            },
            "downloads": -1,
            "filename": "ansible_mdgen-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "31513c19979a8c2fd50ad3bdb0cab235",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 16357,
            "upload_time": "2023-11-14T12:42:50",
            "upload_time_iso_8601": "2023-11-14T12:42:50.875093Z",
            "url": "https://files.pythonhosted.org/packages/fc/37/56c0c93eb5318b0dd302fbc7f18281cd9a05c92d826b9f1dc2ead97066cb/ansible_mdgen-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "55050d1ad362ea6322933446e2c88b256a1494161bb458b2ee963e28957b6e04",
                "md5": "168a66b7c77c57c68f3f0317388a2af3",
                "sha256": "38a3861de6bb8af149753ad0f0fa64f87089d4b644501d04596349ae32e0a783"
            },
            "downloads": -1,
            "filename": "ansible-mdgen-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "168a66b7c77c57c68f3f0317388a2af3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 11394,
            "upload_time": "2023-11-14T12:42:52",
            "upload_time_iso_8601": "2023-11-14T12:42:52.267945Z",
            "url": "https://files.pythonhosted.org/packages/55/05/0d1ad362ea6322933446e2c88b256a1494161bb458b2ee963e28957b6e04/ansible-mdgen-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-14 12:42:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "murphypetercl",
    "github_project": "ansible-mdgen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "requirements": [],
    "lcname": "ansible-mdgen"
}