{ "info": { "author": "Konstantin Molchanov", "author_email": "moigagoo@live.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "##############\nswagger2sphinx\n##############\n\nSwagger_ is an open specification for documenting REST APIs in JSON or YAML.\nImperfect as it is, it's de facto a standard for many API developers.\n\nThis extension lets you render your swagger.json file as a Sphinx document.\nIt uses `HTTP domain`_ directives for paths_ and a glossary for definitions_.\n\n.. _Swagger: http://swagger.io/\n.. _HTTP domain: https://pythonhosted.org/sphinxcontrib-httpdomain/\n.. _paths: http://swagger.io/specification/#pathsObject\n.. _definitions: http://swagger.io/specification/#definitionsObject\n\n\n.. warning::\n\n This extension was created for a particular project and thus is only\n guaranteed to work with this particular project! It is very much likely\n you'll have to modify swagger-api.rst_ for your project.\n\n\n*****\nUsage\n*****\n\n#. Install the extension:\n\n .. code-block:: shell\n\n $ pip install sphinxcontrib-swagger2sphinx\n\n#. Copy the content of swagger-api.rst_ to the file where you want\n your Swagger file rendered.\n\n#. Add the extension to your ``conf.py``:\n\n .. code-block::\n\n extensions = [\n 'sphinxcontrib.swagger2sphinx',\n ...\n ]\n\n#. Specify the path to your Swagger file in ``conf.py``. It can be a local\n path or a URL:\n\n .. code-block:: python\n\n swagger2sphinx_swagger_location = \"swagger.json\"\n # swagger2sphinx_swagger_location = \"http://example.com/swagger.json\"\n\n.. _swagger-api.rst: https://bitbucket.org/moigagoo/sphinxcontrib-swagger2sphinx/src/default/swagger-api.rst\n\n\n************\nTestimonials\n************\n\nThanks to Eric Holscher for writing `an excellent blog post`_ about extending\nSphinx with Jinja2 templating.\n\n.. _an excellent blog post: http://ericholscher.com/blog/2016/jul/25/integrating-jinja-rst-sphinx/\n", "description_content_type": null, "docs_url": null, "download_url": "https://pypi.org/project/sphinxcontrib-swagger2sphinx", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/moigagoo/sphinxcontrib-swagger2sphinx", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-swagger2sphinx", "package_url": "https://pypi.org/project/sphinxcontrib-swagger2sphinx/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-swagger2sphinx/", "project_urls": { "Download": "https://pypi.org/project/sphinxcontrib-swagger2sphinx", "Homepage": "https://bitbucket.org/moigagoo/sphinxcontrib-swagger2sphinx" }, "release_url": "https://pypi.org/project/sphinxcontrib-swagger2sphinx/0.1.4/", "requires_dist": null, "requires_python": "", "summary": "Converter from Swagger to Sphinx HTTP domain.", "version": "0.1.4" }, "last_serial": 2385975, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "cb3efe2acbabdb13495dc4cfebd992c8", "sha256": "cb5fe4683f7a4a6bdf61f0e280b4e0174ac0125f72733a78a341f5e3da5e7a94" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "cb3efe2acbabdb13495dc4cfebd992c8", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4629, "upload_time": "2016-09-28T12:55:23", "url": "https://files.pythonhosted.org/packages/81/c8/0c23da68d62045641d2df67ba8e2584cc114b333e201c1a28b1ef65dc7f0/sphinxcontrib_swagger2sphinx-0.1.0-py3-none-any.whl" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "2bc0518b518548310206de17cba4485c", "sha256": "0a811331bf1d5eafba5954231833383300cef2c7006f8c2133cb79fde9e71604" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2bc0518b518548310206de17cba4485c", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4630, "upload_time": "2016-09-28T13:00:54", "url": "https://files.pythonhosted.org/packages/d4/a6/9bcdb55696ac6349920a9e05ac296b58f3caafcd93d7b841d08d3202b7b3/sphinxcontrib_swagger2sphinx-0.1.1-py3-none-any.whl" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "9a08afda0e9e3206f6f585646da8b91d", "sha256": "a6d4847ac5f066d2da741a450ae8cee60c6c9a5905af4320dd16e45081f64f3e" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9a08afda0e9e3206f6f585646da8b91d", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4633, "upload_time": "2016-09-30T11:48:08", "url": "https://files.pythonhosted.org/packages/ab/b5/c8f5b9567c1c65cda024abb916f45e2051325f09ddd7fa28ece23bccc9cd/sphinxcontrib_swagger2sphinx-0.1.2-py3-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "2becf96ea7499d3ab258702378779d47", "sha256": "51cad160a3040b45abae7d3ef8f49bfed7666618b655ebc68e96b4edc4fda4ba" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "2becf96ea7499d3ab258702378779d47", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4645, "upload_time": "2016-10-04T08:31:32", "url": "https://files.pythonhosted.org/packages/67/cd/007f1df4608094348db6d20bab550a076c73133e34b1129012d53f1e16ee/sphinxcontrib_swagger2sphinx-0.1.3-py3-none-any.whl" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "029e2ae8ff36639f4872f72e26c011c5", "sha256": "6c3695d569db096a6af390f7e1711085d1764b12cd1579edabb7bdd54337c948" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "029e2ae8ff36639f4872f72e26c011c5", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4653, "upload_time": "2016-10-07T05:25:49", "url": "https://files.pythonhosted.org/packages/4b/41/86e8b8f0a2b41c68426af483a9388b6b13de1abe584ef7b9d619060258c5/sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "029e2ae8ff36639f4872f72e26c011c5", "sha256": "6c3695d569db096a6af390f7e1711085d1764b12cd1579edabb7bdd54337c948" }, "downloads": -1, "filename": "sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "029e2ae8ff36639f4872f72e26c011c5", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 4653, "upload_time": "2016-10-07T05:25:49", "url": "https://files.pythonhosted.org/packages/4b/41/86e8b8f0a2b41c68426af483a9388b6b13de1abe584ef7b9d619060258c5/sphinxcontrib_swagger2sphinx-0.1.4-py3-none-any.whl" } ] }