{ "info": { "author": "Unai Aguilera", "author_email": "unai.aguilera@deusto.es", "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": "========================\nsphinxcontrib-swaggerdoc\n========================\n\nSphinx extension for documenting Swagger 2.0 APIs\n\n.. code:: bash\n\n pip install sphinxcontrib-swaggerdoc\n\nUsage\n=====\n\nInclude extension in ``conf.py``\n\n.. code:: python\n\n extensions = ['sphinxcontrib.swaggerdoc']\n\nAdd directive pointing to a remote Swagger api-docs\n\n.. code:: restructuredtext\n\n .. swaggerv2doc:: URL/swagger.json\n\nor to a local file\n\n.. code:: restructuredtext\n\n .. swaggerv2doc:: file:///PATH/swagger.json\n\nFor example\n\n.. code:: restructuredtext\n\n .. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json\n\nIf the Swagger description contains multiple tags, you can select a subset\nfor the documentation generation. For example, the following directive only\ngenerates the documentation for the methods contained in tags **pet** and\n**store**.\n\n.. code:: restructuredtext\n\n .. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json\n pet\n store\n\nNote\n====\n\nThe old directive for Swagger 1.0 is still usable. For example,\n\n.. code:: restructuredtext\n\n .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/pet\n .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/user\n .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/store\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/unaguil/sphinx-swaggerdoc", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-swaggerdoc", "package_url": "https://pypi.org/project/sphinxcontrib-swaggerdoc/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-swaggerdoc/", "project_urls": { "Homepage": "https://github.com/unaguil/sphinx-swaggerdoc" }, "release_url": "https://pypi.org/project/sphinxcontrib-swaggerdoc/0.1.7/", "requires_dist": [ "sphinx", "requests", "requests-file", "future" ], "requires_python": "", "summary": "Sphinx extension for documenting Swagger 2.0 APIs", "version": "0.1.7" }, "last_serial": 3228025, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "94b95c1e5625cd05cd9f7788179133ec", "sha256": "e5dd2617926c414a39c66dac1bf0cfa7cfffbcfd53db2a1ecd4113e745a15b1c" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.1-py2-none-any.whl", "has_sig": false, "md5_digest": "94b95c1e5625cd05cd9f7788179133ec", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6510, "upload_time": "2017-01-27T14:47:15", "url": "https://files.pythonhosted.org/packages/17/c0/5bbda504177ca0b2e9b217bdb242a22eed0594dddd6637f35d9b661ae6bd/sphinxcontrib_swaggerdoc-0.1.1-py2-none-any.whl" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "a67a337bd11f1482d177d1fa3b8280bb", "sha256": "ac8fe0a082d03f31093d45eba29e6584c19b5824343a4fa34324b31f299ed4b1" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.2-py2-none-any.whl", "has_sig": false, "md5_digest": "a67a337bd11f1482d177d1fa3b8280bb", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6508, "upload_time": "2017-01-27T14:58:41", "url": "https://files.pythonhosted.org/packages/99/65/e5b083926f3341bec54941de5ecacf218016442c3b9c3af3b01d402a2a2a/sphinxcontrib_swaggerdoc-0.1.2-py2-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "dbd4bb67e58e3c1d5d33590a58a1724c", "sha256": "b9f820a680bfe32afb511d275216246dc1e7868d6986631dce2c96e2e3493be6" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.3-py2-none-any.whl", "has_sig": false, "md5_digest": "dbd4bb67e58e3c1d5d33590a58a1724c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 6920, "upload_time": "2017-01-27T15:14:42", "url": "https://files.pythonhosted.org/packages/48/58/f3bcc970695d93f2981ef1ba623189798aa7449f5328ed3cc6ae76633dc5/sphinxcontrib_swaggerdoc-0.1.3-py2-none-any.whl" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "9656f12f28eaaaf8ae2c7bc1ab869ca7", "sha256": "ae616406c403e22464718db4b5e8e86871be79a1e04cc77d58be8b2afd757cce" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9656f12f28eaaaf8ae2c7bc1ab869ca7", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7005, "upload_time": "2017-03-24T09:00:16", "url": "https://files.pythonhosted.org/packages/33/39/abf76303628e61a813cdfab64f07f4b7e6752223a23a451bbd218cabf2f6/sphinxcontrib_swaggerdoc-0.1.4-py2.py3-none-any.whl" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "b416ab7c2c784d9dd58bf30c39bdcc50", "sha256": "35dfbc042cb01f97e683d2739075469a5ca72e610a8aa10521daa986f4fa17e9" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b416ab7c2c784d9dd58bf30c39bdcc50", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7258, "upload_time": "2017-07-21T09:29:29", "url": "https://files.pythonhosted.org/packages/dc/d3/1ee29015733858eb5260b9f015a048a75da570a2b5176815f0af13f2a264/sphinxcontrib_swaggerdoc-0.1.5-py2.py3-none-any.whl" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "b0d98fb22dae20d9e57ac816bd6fb741", "sha256": "6a0bfaed0c0bebb2d796e415da5984f490ecd938c74ffb9b122f26f1fb5b4526" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b0d98fb22dae20d9e57ac816bd6fb741", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7559, "upload_time": "2017-09-29T09:25:03", "url": "https://files.pythonhosted.org/packages/49/4a/3d093ab29d4887d4b9d6324635368e93c60f87dd42c30b41ce0623200845/sphinxcontrib_swaggerdoc-0.1.6-py2.py3-none-any.whl" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "c6b59b9f17830eb1bdd5e4b562ec3891", "sha256": "3ee69c6d53ee216405fa201cbd2ae47dd71aeef2a63ddcae595081c2459c2498" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c6b59b9f17830eb1bdd5e4b562ec3891", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7570, "upload_time": "2017-10-05T14:17:08", "url": "https://files.pythonhosted.org/packages/30/12/9a2d31c9369ef1b1a14d7f47ce8fcfa4fe62aa1c4e9cf259915dfb7f1a4d/sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c6b59b9f17830eb1bdd5e4b562ec3891", "sha256": "3ee69c6d53ee216405fa201cbd2ae47dd71aeef2a63ddcae595081c2459c2498" }, "downloads": -1, "filename": "sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c6b59b9f17830eb1bdd5e4b562ec3891", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7570, "upload_time": "2017-10-05T14:17:08", "url": "https://files.pythonhosted.org/packages/30/12/9a2d31c9369ef1b1a14d7f47ce8fcfa4fe62aa1c4e9cf259915dfb7f1a4d/sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl" } ] }