{ "info": { "author": "Ihor Kalnytskyi", "author_email": "ihor@kalnytskyi.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation" ], "description": "=====================\nsphinxcontrib-openapi\n=====================\n\n**sphinxcontrib-openapi** is a `Sphinx`_ extension to generate APIs docs from\n`OpenAPI`_ (fka Swagger) spec. It depends on `sphinxcontrib-httpdomain`_ that\nprovides an HTTP domain for describing RESTful HTTP APIs, so we don't need to\nreinvent the wheel.\n\n.. code:: bash\n\n pip install sphinxcontrib-openapi\n\n\nUsage\n=====\n\nPass ``sphinxcontrib-openapi`` to ``extensions`` list in Sphinx's ``conf.py``\n\n.. code:: python\n\n extensions = [\n ...\n 'sphinxcontrib.openapi',\n ]\n\nand feel free to use the ``openapi`` directive to render OpenAPI specs\n\n.. code:: restructuredtext\n\n .. openapi:: path/to/openapi.yml\n\n\nLinks\n=====\n\n* Documentation: https://sphinxcontrib-openapi.readthedocs.org/\n* Source: https://github.com/ikalnytskyi/sphinxcontrib-openapi\n* Bugs: https://github.com/ikalnytskyi/sphinxcontrib-openapi/issues\n\n\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n.. _OpenAPI: https://github.com/OAI/OpenAPI-Specification\n.. _sphinxcontrib-httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ikalnytskyi/sphinxcontrib-openapi", "keywords": "sphinx openapi swagger rest api renderer docs", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-openapi", "package_url": "https://pypi.org/project/sphinxcontrib-openapi/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-openapi/", "project_urls": { "Homepage": "https://github.com/ikalnytskyi/sphinxcontrib-openapi" }, "release_url": "https://pypi.org/project/sphinxcontrib-openapi/0.5.0/", "requires_dist": null, "requires_python": "", "summary": "OpenAPI (fka Swagger) spec renderer for Sphinx", "version": "0.5.0" }, "last_serial": 5784108, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "a9a4f176fe757d3215e76981f735b904", "sha256": "dc28176eb317d3686ff5958a30c12fce8ca3cb24800faebc80111263dc85eecc" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.1.0.tar.gz", "has_sig": false, "md5_digest": "a9a4f176fe757d3215e76981f735b904", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7290, "upload_time": "2016-10-03T08:18:17", "url": "https://files.pythonhosted.org/packages/f7/99/768c401ad7ad6b12f9ce31283a31fe52138fc98600a68279b9e82e1c51fa/sphinxcontrib-openapi-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "547cb5494a4b392452885772271cab3b", "sha256": "beb9701d37a55abeb1c4e65cc12ddb8ae6f53a142068779f3680d8af32c0fafb" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.2.0.tar.gz", "has_sig": false, "md5_digest": "547cb5494a4b392452885772271cab3b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7939, "upload_time": "2016-11-16T12:49:57", "url": "https://files.pythonhosted.org/packages/a3/7b/c775976700bc7af7c81057c896394207c39984e4dd2f9feee749157b447f/sphinxcontrib-openapi-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "995b0f9923136e2c771ca15cdc64cf2f", "sha256": "ac13232afe8caffac715bfb2f74e5cc027fa855b2d6cf31731f9ac5875ce6f1c" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.2.1.tar.gz", "has_sig": false, "md5_digest": "995b0f9923136e2c771ca15cdc64cf2f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8041, "upload_time": "2017-01-10T19:37:47", "url": "https://files.pythonhosted.org/packages/9e/02/0a574d0e6b37f1593d839fa8d4fb066ea6e95a8e08460cab63f202e0c754/sphinxcontrib-openapi-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "04a17bed1f180fbf0a85100750f41891", "sha256": "6637056dee847bc6aa79e0f4b42011665de6b679fbd723c9ccb05a7b068ed63b" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.3.0.tar.gz", "has_sig": false, "md5_digest": "04a17bed1f180fbf0a85100750f41891", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10400, "upload_time": "2017-01-29T13:37:00", "url": "https://files.pythonhosted.org/packages/00/0e/1534933c1a136af9d855a8815bb6db24ea9e4bc637316dc905e4e8bf20d2/sphinxcontrib-openapi-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "1421afb9e695b4bd13cb7919b983fc17", "sha256": "4b8106641b5b3abb90ca21db5a0b2956a91bfac61212075854efdcabb6139c12" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.3.1.tar.gz", "has_sig": false, "md5_digest": "1421afb9e695b4bd13cb7919b983fc17", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10210, "upload_time": "2017-05-18T21:48:45", "url": "https://files.pythonhosted.org/packages/d8/df/f23588b8a9d594ff308576abffdd7aa7891555c21be41c1b0bf19e83ca3c/sphinxcontrib-openapi-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "8b6497284240fbfc4496618a2830d948", "sha256": "411da1819fda0593976a157f1a14ec1cfaef9ee1b4b708e795d0bf3953f0142b" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.3.2.tar.gz", "has_sig": false, "md5_digest": "8b6497284240fbfc4496618a2830d948", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10299, "upload_time": "2017-10-05T15:19:59", "url": "https://files.pythonhosted.org/packages/5f/32/19cd5a27b9328948d81d48b1569f4a39c6a6cb4dff92613c8b4ab81b5083/sphinxcontrib-openapi-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "e4b81f88299ffdacf9f1b0ec3f8a2c7c", "sha256": "9d64c8a119bfc592e6316af3e5475ce2d4d8ed6e013dc016a3f2e7971e50d7f3" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.4.0.tar.gz", "has_sig": false, "md5_digest": "e4b81f88299ffdacf9f1b0ec3f8a2c7c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 168158, "upload_time": "2019-01-17T19:38:44", "url": "https://files.pythonhosted.org/packages/41/0b/09eec6aff517df2ebad57e79f4ee24fac4d57e7c8b305a604ca3f936c0a8/sphinxcontrib-openapi-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "4ed822b461d4b01af1a5ed63afe8ed42", "sha256": "2a5883456c0caba0dad90f07968c75a50d5fc425a3aa06d1c538472ddf8c7e22" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.5.0.tar.gz", "has_sig": false, "md5_digest": "4ed822b461d4b01af1a5ed63afe8ed42", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 171819, "upload_time": "2019-09-05T01:07:14", "url": "https://files.pythonhosted.org/packages/97/a3/24cd0028774c75482ec11ed35ebfbb125ed882f84987811799ee23ead11e/sphinxcontrib-openapi-0.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4ed822b461d4b01af1a5ed63afe8ed42", "sha256": "2a5883456c0caba0dad90f07968c75a50d5fc425a3aa06d1c538472ddf8c7e22" }, "downloads": -1, "filename": "sphinxcontrib-openapi-0.5.0.tar.gz", "has_sig": false, "md5_digest": "4ed822b461d4b01af1a5ed63afe8ed42", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 171819, "upload_time": "2019-09-05T01:07:14", "url": "https://files.pythonhosted.org/packages/97/a3/24cd0028774c75482ec11ed35ebfbb125ed882f84987811799ee23ead11e/sphinxcontrib-openapi-0.5.0.tar.gz" } ] }