{ "info": { "author": "WAKAYAMA Shirou", "author_email": "shirou.faw@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "sphinxcontrib-ansibleautodoc\n================================================\n\n`sphinxcontrib-ansibleautodoc` is an sphinx extension which can search task in ansible playbook and generate document.\n\ninstall\n----------------\n\n::\n\n pip install sphinxcontrib-ansibleautodoc\n\n\nand add `'sphinxcontrib.ansibleautodoc'` in extensions in your conf.py.\n\n::\n\n extensions = [\n 'sphinxcontrib.ansibleautodoc',\n ]\n\n\nHow to use\n------------------------\n\nCurrently there is one directive called `ansibleautotask`.\n\nansibleautotask\n````````````````````````````````````\n\n::\n\n .. ansibleautotask:: second task\n :playbook: ../ansible/web.yml\n\nThe contents of this directive is an ansible task name. If task does not have a name, directive can not find.\n\n`playbook` option is for specify initial ansible playbook. ansibleautodoc scan the playbook and read include and roles as followes. So you need only one playbook file.\n\n\nOutput Example\n--------------------\n\n.. image:: images/screenshot-1.png\n :scale: 50 %\n\nRelated\n----------\n\nAnsible\n https://ansible.com\n\nLicense\n-------------\n\n2-clause BSD License\n\n", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-ansibleautodoc", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/shirou/sphinxcontrib-ansibleautodoc", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib_ansibleautodoc", "package_url": "https://pypi.org/project/sphinxcontrib_ansibleautodoc/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib_ansibleautodoc/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-ansibleautodoc", "Homepage": "http://github.com/shirou/sphinxcontrib-ansibleautodoc" }, "release_url": "https://pypi.org/project/sphinxcontrib_ansibleautodoc/0.0.5/", "requires_dist": null, "requires_python": "", "summary": "autodoc for ansible playbook", "version": "0.0.5" }, "last_serial": 3601229, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "dfdb42fcf42f3d718f397ee71871b938", "sha256": "6b5a566289ad8b692635238cb847aeb168fc3e77a95eda7b9f045a2059269153" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "dfdb42fcf42f3d718f397ee71871b938", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4494, "upload_time": "2016-07-27T06:39:57", "url": "https://files.pythonhosted.org/packages/6c/de/959ab59df07146ba01fc29ef4b12b3a4a44627c0caa0bf605f19bec7c386/sphinxcontrib_ansibleautodoc-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "da80e9d9a869e33c57ae1931b1483c42", "sha256": "d0bb6fce43619879f76f7e8b05bef5d77832e3153849373b3dcd08cb95f530fe" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "da80e9d9a869e33c57ae1931b1483c42", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4666, "upload_time": "2016-07-27T06:43:32", "url": "https://files.pythonhosted.org/packages/52/2e/1803f455b6a1e7d411df887a10919881c3c28a448bb8100f83b589821a46/sphinxcontrib_ansibleautodoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "5daed407ac131e3841427a4a65db9240", "sha256": "24051baa8bf02aaa5739ab4c8cc2c56f3ef40c0e2f1082fb44edacac4d32dbc8" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "5daed407ac131e3841427a4a65db9240", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4663, "upload_time": "2016-07-29T07:37:21", "url": "https://files.pythonhosted.org/packages/d1/5b/560573250379e42b969cf1c634df5fa79bd716a18f6d415512011a1537d6/sphinxcontrib_ansibleautodoc-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "e98ef1711f95ccc8a00877a4cfe1dfc0", "sha256": "b0e7ca95baebeb7a18e3fe2833c30066dde0cca07b996674b3bff827be0f1b85" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "e98ef1711f95ccc8a00877a4cfe1dfc0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4735, "upload_time": "2016-12-21T14:12:27", "url": "https://files.pythonhosted.org/packages/c4/61/7604bbf17a5122877d79c8a203aa9e18becad97f3a98b26ba8e75fa003ac/sphinxcontrib_ansibleautodoc-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "e95a1fe68ee7655a2550ae1b57b4bb3c", "sha256": "73b4032f7a64ec0ac2ba8d85175aa4d78534272260fa4162f2aa1e8d3262d5f4" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.5.tar.gz", "has_sig": false, "md5_digest": "e95a1fe68ee7655a2550ae1b57b4bb3c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5076, "upload_time": "2018-02-21T05:58:00", "url": "https://files.pythonhosted.org/packages/98/54/e17e01dee0627f215378f44c8f502db63ff784022372bfec4a8242495fb6/sphinxcontrib_ansibleautodoc-0.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e95a1fe68ee7655a2550ae1b57b4bb3c", "sha256": "73b4032f7a64ec0ac2ba8d85175aa4d78534272260fa4162f2aa1e8d3262d5f4" }, "downloads": -1, "filename": "sphinxcontrib_ansibleautodoc-0.0.5.tar.gz", "has_sig": false, "md5_digest": "e95a1fe68ee7655a2550ae1b57b4bb3c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5076, "upload_time": "2018-02-21T05:58:00", "url": "https://files.pythonhosted.org/packages/98/54/e17e01dee0627f215378f44c8f502db63ff784022372bfec4a8242495fb6/sphinxcontrib_ansibleautodoc-0.0.5.tar.gz" } ] }