{
    "info": {
        "author": "Andres Bott",
        "author_email": "contact@andresbott.com",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Intended Audience :: Information Technology",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
            "Natural Language :: English",
            "Operating System :: POSIX",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: Software Development",
            "Topic :: Software Development :: Documentation",
            "Topic :: System :: Installation/Setup",
            "Topic :: System :: Systems Administration",
            "Topic :: Utilities"
        ],
        "description": "# ansible-autodoc\n\n[![CircleCI](https://circleci.com/gh/AndresBott/ansible-autodoc/tree/master.svg?style=svg)](https://circleci.com/gh/AndresBott/ansible-autodoc/tree/master)\n\nGenerate documentation from annotated playbooks and roles using templates.\n\n    Note: this project is currently in Beta, issues, ideas and pull requests are welcome.\n\n# Features\n* allow to document playbook projects and roles\n* use templates to generate and maintain the documentation\n* extended functions when documenting:\n   * tags: the autodoc will search for used tags in the project\n\n# Getting started\n\n```\n# install \npip install ansible-autodoc\n\n# print help \nansible-autodoc -h \n\n# print parsed annotation results in the cli \nansible-autodoc -p all path/to/role_or_playbook \n\n# generate README file based on annotations  \nansible-autodoc [path/to/project] \n``` \n\nnotes: \n* you can use [grip](https://pypi.org/project/grip/) to see the live changes.\n* this only runs with python 3, if you still have python 2.x use pip3\n\n\n# Annotations\n\nUse the following annotations in your playbooks and roles\n\n* __meta:__ use @meta to annotate the metadata of playbook or role, like author\ncheck below list of useful metadata\n  * author: (self explanatory)\n  * description: playbook / role description\n  * name: to define a different role/project name instead of the folder name\n  * license: (self explanatory)\n  * email: (self explanatory)\n\n```yaml\n# @meta author: Author Name\n# @meta description: Project description\n```  \n* __todo:__ use @todo to annotate improvements, bugs etc\n```yaml\n# @todo bug: bug description\n# @todo improvement: improvement \n```\n\n* __action:__ use @action to annotate a actions performed by the playbook/role\n```yaml\n# @action install # this action describes the installation  \n# @action # this action does not have a section, only description \n```\n\n* __tags:__ use @tag to annotate tags, this is a special annotation as this will not only search for annotations,\nbut also for used tags in the project and add that to the generated output.\n```yaml\n# @tag tagname # tag description   \n```\n\n\n* __variables:__ use @var this to annotate configuration variables\n```yaml\n# @var my_var: default_value # description of the variable   \n```\n\n* __example:__ the idea is that after every annotation, we can define an example block, linked to the annotation.\nin this case the example will be part of the var annotation.\n```yaml\n# @var my_var: default_value # description of the variable   \nmy_var: default_value\n# @example # the hash is needed due to the parser constrains\n# my_var:\n#  - subitem: string\n#  - subitem2: string\n# @end\n``` \n\n# Templates\n\nansible-autodoc comes with 3 templates out of the box, the default is \"readme\", you can change this in configuration.\n\nIf you want to create your own project specific templates, see the [template documentation](doc/templates.md)\n\nIf a file already exists in the output, the you will be prompted to overwrite or abort.\n\n### README\n\nThe default \"readme\" template will generate a README.md file in the root of the project, detailing the sections:\n\n* title and description\n* actions\n* tags\n* variables\n* todos\n* license\n* author infomration\n\nyou can extend this my creating a file `\"_readme_doby.md\"` in the root of your project, this will be included in the rendered Readme just after the \ninitial description.\n\n### Doc and README\n\nThe \"doc_and_readme\" template is an extended template intended to be used playbook projects with several roles, it will generate a minimal\nREADME.md file and a documentation subfolder \"doc\" with more detailed information.\n\nyou can extend this my creating a file `\"_readme_doby.md\"` in the root of your project, this will be included in the rendered Readme just after the \ninitial description.\n\nthe files created in the documentation folder will cover: \n\n* tags: list all tags classified by roles\n* variables: list all variables classified by roles\n* todo: list all todo actions classified by roles\n* report: provides a report of the project and useful information during development\n\nyou can extend the documentation in this folder, just keep in mind that generated files will be overwritten.\n\n\n### Command line \n\nThe \"cliprint\" template is used to display the content when you use the command line print parameter \"-p\"\n\n\n## Configuration\nyou can create a configuration file \"autodoc.config.yaml\" in the root of your project in order to modify\nseveral behaviours, see the sample config file for more details:\n\n```$xslt\n# role or project with playbooks\n$ cd <project> \n\n# create sample configuration (optional) \n# you can pass the options as parameters too\n$ ansible-autodoc --sample-doc > autodoc.config.yaml\n```\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/AndresBott/ansible-autodoc",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ansible-autodoc",
        "package_url": "https://pypi.org/project/ansible-autodoc/",
        "platform": "",
        "project_url": "https://pypi.org/project/ansible-autodoc/",
        "project_urls": {
            "Homepage": "https://github.com/AndresBott/ansible-autodoc"
        },
        "release_url": "https://pypi.org/project/ansible-autodoc/0.5.3/",
        "requires_dist": [
            "jinja2",
            "pyyaml"
        ],
        "requires_python": "",
        "summary": "Generate documentation from annotated playbooks and roles using templates",
        "version": "0.5.3"
    },
    "last_serial": 4888718,
    "releases": {
        "0.5.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "46c92394e9a65ca3863d262133d831fd",
                    "sha256": "cfb6ab17eed49f1656735eb8fd7243c1b21173a66aed4e20f6108056c994ca86"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "46c92394e9a65ca3863d262133d831fd",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 28593,
                "upload_time": "2019-02-17T18:09:36",
                "url": "https://files.pythonhosted.org/packages/01/9c/cd8ecc714e2e96931dfc4c495450e4976d43c7d82ffae60dd91117d4e622/ansible_autodoc-0.5.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a9326632c20faa2d749ebd0546082286",
                    "sha256": "8d58353d61940a8d5a4a13e9233235ad12caffff3586f626f1df1a39de3ab3d6"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "a9326632c20faa2d749ebd0546082286",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19444,
                "upload_time": "2019-02-17T18:09:38",
                "url": "https://files.pythonhosted.org/packages/93/b7/822a3ed8993357a601f6596715868dfc444a546cf763f120c5babd2597d7/ansible-autodoc-0.5.1.1.tar.gz"
            }
        ],
        "0.5.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e83e1b5550fec32217ac8db9527bb86e",
                    "sha256": "04af4f91e1ddd82e4950477ae49cc77f483caf64fb149d0108a9ea55ff439247"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e83e1b5550fec32217ac8db9527bb86e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 20409,
                "upload_time": "2019-02-17T18:24:45",
                "url": "https://files.pythonhosted.org/packages/7f/a6/cacd5d949fb5bab3c77fb9350f9043aafc7a32a50bfe04fa9f0ac8133efc/ansible_autodoc-0.5.1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b9ec08338ee5ebbdc6c6f1e77fc37b44",
                    "sha256": "7e78349b866514bdd38f40b9bb87ac56c7ea9f7fb66170b6f8e40e8eb03e0d17"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "b9ec08338ee5ebbdc6c6f1e77fc37b44",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19493,
                "upload_time": "2019-02-17T18:24:46",
                "url": "https://files.pythonhosted.org/packages/25/01/d41fb5fc5611c51b2b0993ad081bffc3134e6fa10658010b4cb918d091dc/ansible-autodoc-0.5.1.2.tar.gz"
            }
        ],
        "0.5.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ae497b98fd4c9a6b17ac413b87c581ed",
                    "sha256": "656e57160f46e58d26c8b014cad2d0d25baff6fe2bf2e64cb79568b38148ab5e"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ae497b98fd4c9a6b17ac413b87c581ed",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 28648,
                "upload_time": "2019-02-17T18:41:25",
                "url": "https://files.pythonhosted.org/packages/d2/23/dc023def8fbb5eb8a5e77f0b891c1aa71df6cd0e4c42c91cef1bea528aa4/ansible_autodoc-0.5.1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "de557340bdc086f4ea535ccdf9836a2c",
                    "sha256": "b8fe0c86fa1d796a7f7188b0d0c085fe95c89cdba5388b692fa3fa17307cdbac"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "de557340bdc086f4ea535ccdf9836a2c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19575,
                "upload_time": "2019-02-17T18:41:27",
                "url": "https://files.pythonhosted.org/packages/9d/c5/de1c154b026721dc286085e3858939450f89bcd7cbf81e42c1696e3db11d/ansible-autodoc-0.5.1.3.tar.gz"
            }
        ],
        "0.5.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6982b8c05f09b16f183d41e20f0bfc00",
                    "sha256": "ee13f7ba4aad9db76cb43fcc170f010a18ce88b4a9d98835662d395d15a66865"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.1.5-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6982b8c05f09b16f183d41e20f0bfc00",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 28086,
                "upload_time": "2019-02-17T20:41:45",
                "url": "https://files.pythonhosted.org/packages/fd/58/c718a31eb56462dac1b6a592f43184e64adb0894afb489082ee6c917e3c0/ansible_autodoc-0.5.1.5-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "df3ba8d65829c602babbce02652f11e4",
                    "sha256": "768b4b1e32b1f807a0e2a5f1bf1f7378a99f31d76019e4d2f5eac535d42d2edf"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "df3ba8d65829c602babbce02652f11e4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19940,
                "upload_time": "2019-02-17T20:41:46",
                "url": "https://files.pythonhosted.org/packages/10/86/eb635ee43d046503820fefc95cb510971033d954c4787e2d64d57af48c8b/ansible-autodoc-0.5.1.5.tar.gz"
            }
        ],
        "0.5.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "91c98671a46d5b32118c30648dc85ee9",
                    "sha256": "2afba5ea7789ba652e21a95992a51af09c3e5e85e98c7a1d64c094ed6fd05846"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "91c98671a46d5b32118c30648dc85ee9",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 28062,
                "upload_time": "2019-02-17T20:55:50",
                "url": "https://files.pythonhosted.org/packages/df/9f/ca42059cc7cf852236a1db1c189f54dd822468a6fef197dc9efb12f070dd/ansible_autodoc-0.5.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f45dd90dae9ac286b44f0d12acbfede3",
                    "sha256": "9aa4c777c2b70a95ab24fb62b127c75a3006a24b179d44883e8642418ef1963f"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.2.tar.gz",
                "has_sig": false,
                "md5_digest": "f45dd90dae9ac286b44f0d12acbfede3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19943,
                "upload_time": "2019-02-17T20:55:52",
                "url": "https://files.pythonhosted.org/packages/ec/83/5694c1662d6b6478776762289e9e79202ed4fa8927f8ae6e50b36e78474d/ansible-autodoc-0.5.2.tar.gz"
            }
        ],
        "0.5.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e07da9e35268a14e08d56682091ea992",
                    "sha256": "38c4d428bf8c5d2f01c83cd3e42ea9b935bb11be47f115f9d24e36dae51fb8c8"
                },
                "downloads": -1,
                "filename": "ansible_autodoc-0.5.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e07da9e35268a14e08d56682091ea992",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 28611,
                "upload_time": "2019-03-02T17:26:22",
                "url": "https://files.pythonhosted.org/packages/9c/d5/a561c1347d4c315c384c229a491f37b669cbb8b0cdfff41a18430e4dd158/ansible_autodoc-0.5.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "44f08701e83518e600fba17fb7f84cae",
                    "sha256": "3a741e251853f665805a0ba717acf510e4f38459db05cacf033e8278db0a6528"
                },
                "downloads": -1,
                "filename": "ansible-autodoc-0.5.3.tar.gz",
                "has_sig": false,
                "md5_digest": "44f08701e83518e600fba17fb7f84cae",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19164,
                "upload_time": "2019-03-02T17:26:24",
                "url": "https://files.pythonhosted.org/packages/c3/4b/f09749e7b52e3b3d507d73c76738e20199ffaf476dd58ec6c01c2a28b02d/ansible-autodoc-0.5.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e07da9e35268a14e08d56682091ea992",
                "sha256": "38c4d428bf8c5d2f01c83cd3e42ea9b935bb11be47f115f9d24e36dae51fb8c8"
            },
            "downloads": -1,
            "filename": "ansible_autodoc-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e07da9e35268a14e08d56682091ea992",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 28611,
            "upload_time": "2019-03-02T17:26:22",
            "url": "https://files.pythonhosted.org/packages/9c/d5/a561c1347d4c315c384c229a491f37b669cbb8b0cdfff41a18430e4dd158/ansible_autodoc-0.5.3-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "44f08701e83518e600fba17fb7f84cae",
                "sha256": "3a741e251853f665805a0ba717acf510e4f38459db05cacf033e8278db0a6528"
            },
            "downloads": -1,
            "filename": "ansible-autodoc-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "44f08701e83518e600fba17fb7f84cae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 19164,
            "upload_time": "2019-03-02T17:26:24",
            "url": "https://files.pythonhosted.org/packages/c3/4b/f09749e7b52e3b3d507d73c76738e20199ffaf476dd58ec6c01c2a28b02d/ansible-autodoc-0.5.3.tar.gz"
        }
    ]
}