{ "info": { "author": "Dave Shawley", "author_email": "daveshawley+python@gmail.com", "bugtrack_url": null, "classifiers": [ "Framework :: Sphinx :: Extension", "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" ], "description": "\nsphinx-swagger\n==============\n\nGenerates a swagger API definition directly from `httpdomain`_ based\ndocumentation.\n\nUsage\n-----\n\n1. Enable the extension in your *conf.py* by adding ``'sphinxswagger'``\n to the ``extensions`` list\n2. Run the ``swagger`` builder (e.g., ``setup.py swagger``)\n3. Use the generated *swagger.json*\n\nSetuptools Command\n------------------\nThis library installs a new command named **swagger** that is available\nfrom the *setup.py* utility. It runs sphinx to generate the swagger\noutput file. It is similar to running ``sphinx-build -b swagger`` except\nthat it has access to your packages metadata so you don't have to\nconfigure it in two places!\n\n**This is the recommend approach for using this package.**\n\nYou can configure the output file name in your project's *setup.cfg* in\nthe ``[swagger]`` section::\n\n [swagger]\n output-file = static/swagger.json\n\nThis makes it easier to include it directly into your built artifact\nby adding it as ``package_data`` in *setup.py*. Remember to add it to\nyour *MANIFEST.in* as well.\n\nConfiguration\n-------------\nThis extension contains a few useful configuration values that can be\nset from within the sphinx configuration file.\n\n:swagger_description:\n Sets the description of the application in the generated swagger file.\n If this is not set, then the \"description\" value in ``html_theme_options``\n will be used if it is set.\n\n:swagger_file:\n Sets the name of the generated swagger file. The file is always\n generated in the sphinx output directory -- usually *build/sphinx/swagger*.\n The default file name is *swagger.json*.\n\n:swagger_license:\n A dictionary that describes the license that governs the API. This\n is written as-is to the `License`_ section of the API document. It should\n contain two keys -- **name** and **url**.\n\n.. _httpdomain: https://pythonhosted.org/sphinxcontrib-httpdomain/\n.. _License: https://github.com/OAI/OpenAPI-Specification/blob/master/\n versions/2.0.md#licenseObject\n\n\n", "description_content_type": null, "docs_url": "https://pythonhosted.org/sphinx-swagger/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dave-shawley/sphinx-swagger", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "sphinx-swagger", "package_url": "https://pypi.org/project/sphinx-swagger/", "platform": "", "project_url": "https://pypi.org/project/sphinx-swagger/", "project_urls": { "Homepage": "https://github.com/dave-shawley/sphinx-swagger" }, "release_url": "https://pypi.org/project/sphinx-swagger/0.0.4/", "requires_dist": [ "Sphinx (>=1.4,<2)", "sphinxcontrib-httpdomain (>=1.5.0)" ], "requires_python": "", "summary": "Generate swagger definitions from sphinx docs", "version": "0.0.4" }, "last_serial": 2992233, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "0b9af5d93e08c3970f49a94fe94a037c", "sha256": "a1eb4ca2ff7551e74ac0a58f715edc60ad07b4e961a8f70bdaa106695a98a8af" }, "downloads": -1, "filename": "sphinx_swagger-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "0b9af5d93e08c3970f49a94fe94a037c", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 7523, "upload_time": "2016-06-06T12:02:35", "url": "https://files.pythonhosted.org/packages/65/45/a3b75eb41d533a7506b278ff84e9f5790ab8d18c1eae112edd59331646a6/sphinx_swagger-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3308defb933864377c10240391020d0d", "sha256": "35db3ad7ab56e9066008824b68f1509dbef7535fe4f94ca4571344a777e85f02" }, "downloads": -1, "filename": "sphinx-swagger-0.0.1.tar.gz", "has_sig": false, "md5_digest": "3308defb933864377c10240391020d0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5609, "upload_time": "2016-06-06T12:02:31", "url": "https://files.pythonhosted.org/packages/4f/25/1f51d747fec2ca345c3f4e3cf6d54a6643f009752caee4b874a1062d660e/sphinx-swagger-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "cfbf5dc5c0ad69f0fe2cfcdb37b9f3c5", "sha256": "51d90861412a7c5580db8cf98d642ca29ede581c18251a86fceb86406b676fe2" }, "downloads": -1, "filename": "sphinx_swagger-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "cfbf5dc5c0ad69f0fe2cfcdb37b9f3c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7726, "upload_time": "2017-03-02T12:35:38", "url": "https://files.pythonhosted.org/packages/c6/1c/6be0cca01be187754dc32d5b389c261d4c0ee4333a89432d239a110db7f8/sphinx_swagger-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "42b6293bc8083024cbf53b4dd73a5d22", "sha256": "5e5ad2995e716fe4eade7040acb6783040c9eb82778786020295161f4c4cc228" }, "downloads": -1, "filename": "sphinx-swagger-0.0.2.tar.gz", "has_sig": false, "md5_digest": "42b6293bc8083024cbf53b4dd73a5d22", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5764, "upload_time": "2017-03-02T12:35:40", "url": "https://files.pythonhosted.org/packages/92/43/eb4630957849c0c59bccf5154a5293d8c68f4f5f8d400bc3ecaa62c501d4/sphinx-swagger-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "453d4a9742b67740ba23582f4d6ad9ad", "sha256": "40116f0f266dc4984145b776f5fefa357551df3a3c7e495852df9fb16067626a" }, "downloads": -1, "filename": "sphinx_swagger-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "453d4a9742b67740ba23582f4d6ad9ad", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11682, "upload_time": "2017-03-22T12:03:41", "url": "https://files.pythonhosted.org/packages/08/a1/38a6733fa9c3abc175bc4a71d496388d40027e3211bd215237fd8b6e1346/sphinx_swagger-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "781755be5a2fee4463618be4d97d8a5c", "sha256": "b86af722fab97ad87f7792e0b8f00707198f8c789b85e3511a8366bbdc6ebb45" }, "downloads": -1, "filename": "sphinx-swagger-0.0.3.tar.gz", "has_sig": false, "md5_digest": "781755be5a2fee4463618be4d97d8a5c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9750, "upload_time": "2017-03-22T12:03:42", "url": "https://files.pythonhosted.org/packages/cd/64/17f8db32e1f55faaf7195b1d4f3f810f404345f1b44144129bed3aecd96a/sphinx-swagger-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "5b32673136f8af5ff118971a58d5141d", "sha256": "3dffaca8229a5da35d4b6964716dbcac9fb097db12c65e05f4ba878d0e97e3f3" }, "downloads": -1, "filename": "sphinx_swagger-0.0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5b32673136f8af5ff118971a58d5141d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12331, "upload_time": "2017-07-01T10:27:45", "url": "https://files.pythonhosted.org/packages/91/29/3b17ecdff0b60ca8b7995cf6d773d59a27a5272dac3ffb9ed3a9eb7205d2/sphinx_swagger-0.0.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "982bbbc5029a58cac12cf7b3443fb322", "sha256": "02a56be438abf079a0f3f8dfefa2435179cb58415b4d3ff6aacb087276fc7ff3" }, "downloads": -1, "filename": "sphinx-swagger-0.0.4.tar.gz", "has_sig": false, "md5_digest": "982bbbc5029a58cac12cf7b3443fb322", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8990, "upload_time": "2017-07-01T10:27:50", "url": "https://files.pythonhosted.org/packages/d8/6b/2f4ce2d388049c7e8f76586f785333c2d4af114dadf5a9ae41d5654bf7bd/sphinx-swagger-0.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5b32673136f8af5ff118971a58d5141d", "sha256": "3dffaca8229a5da35d4b6964716dbcac9fb097db12c65e05f4ba878d0e97e3f3" }, "downloads": -1, "filename": "sphinx_swagger-0.0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5b32673136f8af5ff118971a58d5141d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12331, "upload_time": "2017-07-01T10:27:45", "url": "https://files.pythonhosted.org/packages/91/29/3b17ecdff0b60ca8b7995cf6d773d59a27a5272dac3ffb9ed3a9eb7205d2/sphinx_swagger-0.0.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "982bbbc5029a58cac12cf7b3443fb322", "sha256": "02a56be438abf079a0f3f8dfefa2435179cb58415b4d3ff6aacb087276fc7ff3" }, "downloads": -1, "filename": "sphinx-swagger-0.0.4.tar.gz", "has_sig": false, "md5_digest": "982bbbc5029a58cac12cf7b3443fb322", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8990, "upload_time": "2017-07-01T10:27:50", "url": "https://files.pythonhosted.org/packages/d8/6b/2f4ce2d388049c7e8f76586f785333c2d4af114dadf5a9ae41d5654bf7bd/sphinx-swagger-0.0.4.tar.gz" } ] }