{ "info": { "author": "XLAB Steampunk", "author_email": "steampunk@xlab.si", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "Ansible Collection API Documentation Extractor\n==============================================\n\nThis package contains code for Ansible collection documentation extractor. Its\nmain audience are Ansible collection maintainers that would like to publish\nAPI docs in the HTML form without having to manually copy the data already\npresent in the module's metadata.\n\n\nQuickstart\n----------\n\nDocumentation extractor is published on PyPI_ and we can install it using\n``pip``::\n\n $ pip install ansible-doc-extractor\n\nIf the previous command did not fail, we are ready to start extracting the\ndocumentation::\n\n $ ansible-doc-extractor \\\n /tmp/output-folder \\\n ~/.ansible/collections/ansible_collections/my/col/plugins/modules/*.py\n\nThis will extract the documentation from modules in ``my.col`` collection and\nplace resulting rst files into ``/tmp/output-folder``.\n\n.. note::\n Always extract documentation from installed collection. Documentation\n fragment loader fails to combine various parts of the documentation\n otherwise.\n\n.. _PyPI: https://pypi.org/\n\n\nDevelopment setup\n-----------------\n\nGetting development environment up and running is relatively simple if we\nhave ``pipenv`` installed::\n\n $ pipenv update\n\nTo test the extractor, we can run::\n\n $ pipenv run ansible-doc-extractor\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "ansible,documentation", "license": "", "maintainer": "", "maintainer_email": "", "name": "ansible-doc-extractor", "package_url": "https://pypi.org/project/ansible-doc-extractor/", "platform": "", "project_url": "https://pypi.org/project/ansible-doc-extractor/", "project_urls": null, "release_url": "https://pypi.org/project/ansible-doc-extractor/0.1.0/", "requires_dist": [ "ansible", "jinja2", "PyYAML" ], "requires_python": "", "summary": "Extract Ansible module documentation", "version": "0.1.0" }, "last_serial": 5927290, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "e70451591d874774ed8585bac6f0d68c", "sha256": "4b7af559c9635d6b3f2f4947b1464fbef5b2fee225219ac170e7a814b42e4bc3" }, "downloads": -1, "filename": "ansible_doc_extractor-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e70451591d874774ed8585bac6f0d68c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17628, "upload_time": "2019-10-04T08:40:03", "url": "https://files.pythonhosted.org/packages/c9/d8/ca0cb03426ce7bf7db8b3351f1d3ce1948359a2b61206861eb4d1199715b/ansible_doc_extractor-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49ceb036636ceb3b585c4643e79d2229", "sha256": "315ee447793b68dfeb6e4023b2a9561b95f7b3e805af688178e0f6054dcd242c" }, "downloads": -1, "filename": "ansible-doc-extractor-0.1.0.tar.gz", "has_sig": false, "md5_digest": "49ceb036636ceb3b585c4643e79d2229", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16454, "upload_time": "2019-10-04T08:40:07", "url": "https://files.pythonhosted.org/packages/f0/d8/e4bdf2d420fcf820e89934c856aea63849ac43a9d1c8608fa99e7507fb55/ansible-doc-extractor-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e70451591d874774ed8585bac6f0d68c", "sha256": "4b7af559c9635d6b3f2f4947b1464fbef5b2fee225219ac170e7a814b42e4bc3" }, "downloads": -1, "filename": "ansible_doc_extractor-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e70451591d874774ed8585bac6f0d68c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17628, "upload_time": "2019-10-04T08:40:03", "url": "https://files.pythonhosted.org/packages/c9/d8/ca0cb03426ce7bf7db8b3351f1d3ce1948359a2b61206861eb4d1199715b/ansible_doc_extractor-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "49ceb036636ceb3b585c4643e79d2229", "sha256": "315ee447793b68dfeb6e4023b2a9561b95f7b3e805af688178e0f6054dcd242c" }, "downloads": -1, "filename": "ansible-doc-extractor-0.1.0.tar.gz", "has_sig": false, "md5_digest": "49ceb036636ceb3b585c4643e79d2229", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16454, "upload_time": "2019-10-04T08:40:07", "url": "https://files.pythonhosted.org/packages/f0/d8/e4bdf2d420fcf820e89934c856aea63849ac43a9d1c8608fa99e7507fb55/ansible-doc-extractor-0.1.0.tar.gz" } ] }