{
"info": {
"author": "Albert Bagdasaryan",
"author_email": "albert.bagd@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Framework :: Sphinx :: Extension",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"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",
"Topic :: Utilities"
],
"description": "sphinxcontrib-swaggerui\n#######################\n\n.. image:: https://travis-ci.org/sphinx-contrib/sphinxcontrib-swaggerui.svg?branch=master\n :target: https://travis-ci.org/sphinx-contrib/sphinxcontrib-swaggerui\n\nProvides the ``swaggerui`` directive for reST files to build a driven\nby `Swagger-UI `_ interactive panel presenting\nyour `OpenAPI `_ specification document.\n\nOverview\n========\n\nThis Sphinx extension is necessary for those who publish an interactive document presenting their API specification\ncompliant with OpenAPI and want to use the well-known Swagger-UI tool for this purpose.\nThe ``swaggerui`` directive enables you to embed such interactive panel in an arbitrary place of a reST file.\n\nSphinx Directive swaggerui\n==========================\n\nInstallation\n------------\n\n.. code-block:: text\n\n $ pip install sphinxcontrib-swaggerui\n\nConfiguration\n-------------\n\nIn your Sphinx project configuration file ``conf.py``, add the installed extension::\n\n extensions = [...,\n 'sphinxcontrib.swaggerui',\n ...]\n\nThe directive also implies that you use the static content in the **_static/** folder and this is configured as::\n\n html_static_path = ['_static']\n\n\nDirective in reST Files\n-----------------------\n\nUse the following sample configuration (containing all possible options) when testing the directive for the first time::\n\n .. swaggerui:: ../_static/swaggerui/petstore.yaml # *) Required\n :url: https://unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js # *) Required\n :css: ../_static/swaggerui/swagger-ui.css # *) Required\n :script: https://unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js # Optional\n :filter: pets # Optional\n\nAn attribute (for example, ``../_static/swagger/petstore.yaml``) refers to your local YAML or JSON file in\nthe OpenAPI format. The path must be relative to the document containing the directive.\n\nThe directive uses the following options:\n\n* ``url`` refers to a CDN-based (Content Delivery Network) Swagger-UI package. For a proper version of the script, refer\n to the `UNPKG `_ CDN. The script name must be ``swagger-ui-bundle.js``.\n* ``css`` refers to a local Swagger-UI CSS file. The path must be relative to the document containing the directive.\n You can find a proper CSS file in the `UNPKG `_ CDN.\n* ``script`` refers to an additional script (the one in the above example is recommended). For a proper version of\n the script, refer to the `UNPKG `_ CDN. The script name must\n be ``swagger-ui-standalone-preset.js``. Probably, you will find another script that can work with the main\n Swagger-UI script specified by the ``:url:`` option.\n* ``filter`` requires Swagger UI to display only those endpoints (paths) which contain a tag that partially or fully\n matches the filter.\n\n.. note::\n\n 1. This package contains ``petstore.yaml`` and ``swagger-ui.css`` files (mentioned in the above example)\n copied to the ``_static/swaggerui/`` folder during the first use of the directive by Sphinx.\n So don't care about copying these files when you specify the relative path to that folder; the sample files\n will appear automatically in it whether you use them or not.\n\n 2. You will probably need to edit the CSS styles using your own CSS files.\n\n\nSample CSS Customization\n========================\n\nAvoid the operation block tag to disappear::\n\n h4.opblock-tag a.nostyle {\n opacity: 1\n }\n\nRemove the Swagger top-bar::\n\n .swagger-ui .topbar {\n display: none;\n }\n\n\nLinks\n=====\n\n- Source: `Bitbucket `_\n\n.. commented:\n\n - Bugs and issues: `Issues `_",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://bitbucket.org/albert_bagdasaryan/sphinxcontrib-swaggerui/",
"keywords": "",
"license": "BSD",
"maintainer": "",
"maintainer_email": "",
"name": "sphinxcontrib-swaggerui",
"package_url": "https://pypi.org/project/sphinxcontrib-swaggerui/",
"platform": "",
"project_url": "https://pypi.org/project/sphinxcontrib-swaggerui/",
"project_urls": {
"Homepage": "https://bitbucket.org/albert_bagdasaryan/sphinxcontrib-swaggerui/"
},
"release_url": "https://pypi.org/project/sphinxcontrib-swaggerui/0.0.10/",
"requires_dist": null,
"requires_python": "",
"summary": "Provides the swaggerui directive for reST files to build an interactive HTML page with your OpenAPI specification document.",
"version": "0.0.10"
},
"last_serial": 5890305,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "901e32a710987651161b960eac9c25b9",
"sha256": "0971d77abf83fbdf3b7ed8a391a2387e69686cb5e4d12b358f51c93b231352f0"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "901e32a710987651161b960eac9c25b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2478,
"upload_time": "2019-08-20T11:48:22",
"url": "https://files.pythonhosted.org/packages/a2/1f/d7b3be0bfd9140b5e0d634b54d0a00a6d65b670fc5443649efd25fc22ab2/sphinxcontrib-swaggerui-0.0.1.tar.gz"
}
],
"0.0.1.dev1": [
{
"comment_text": "",
"digests": {
"md5": "a7a433c6d9d048ac018f6d8da48aa0a0",
"sha256": "ff90a14839c2ccfa29319ec67ed7d1c5b8731eba1da3f641ab66d137bb6ea43b"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.1.dev1.tar.gz",
"has_sig": false,
"md5_digest": "a7a433c6d9d048ac018f6d8da48aa0a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29975,
"upload_time": "2019-08-20T15:01:08",
"url": "https://files.pythonhosted.org/packages/49/56/09769351e99e939f17d3c70e2a477beeca5598b2adec1912fa9c8f45684a/sphinxcontrib-swaggerui-0.0.1.dev1.tar.gz"
}
],
"0.0.10": [
{
"comment_text": "",
"digests": {
"md5": "76d9a9ed75d9262312474561063750f8",
"sha256": "accb44764e387f986c3bc99690d70e21d4d438ccc3fec6cdee18ec7d5c80ae99"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "76d9a9ed75d9262312474561063750f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58285,
"upload_time": "2019-09-26T12:13:43",
"url": "https://files.pythonhosted.org/packages/cf/03/c973aa05ff6e3e8f0dcffc2d022769948edadf2e2d25ee81d68ad1d47c92/sphinxcontrib-swaggerui-0.0.10.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "1329bce2ac4b9ed6e3148e480d913bfc",
"sha256": "e4d92496a8da885d2b52dfaaa92be7c96cda5b9b10033989acfdce47c4006147"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "1329bce2ac4b9ed6e3148e480d913bfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29960,
"upload_time": "2019-08-20T15:05:40",
"url": "https://files.pythonhosted.org/packages/2f/ea/69702eab1bba54dff4ab1a22e9a93f19193f4cec565635c0293bd1aa71da/sphinxcontrib-swaggerui-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "f2b3077454c8412dfb7f576a56dd1a5f",
"sha256": "9bb006f916949223ed6241ff6cfea0f5a2e7668bff393672964d2c345f707931"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "f2b3077454c8412dfb7f576a56dd1a5f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29842,
"upload_time": "2019-08-20T15:21:08",
"url": "https://files.pythonhosted.org/packages/5d/94/9adb8133bd144e3bc6fc476f0eddc9844e05fc8ec7f7776ff137fc9929ab/sphinxcontrib-swaggerui-0.0.3.tar.gz"
}
],
"0.0.5": [
{
"comment_text": "",
"digests": {
"md5": "57258793e99199284ed607a8622c3ae6",
"sha256": "ff31a98b33653b846d1434161bf80dc4eb13aa8446ccbd40edb28110fba37497"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "57258793e99199284ed607a8622c3ae6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 211077,
"upload_time": "2019-08-21T14:31:30",
"url": "https://files.pythonhosted.org/packages/5c/32/619a3b7bd076d3ef218ff4dc364828d9ae557a486a8445831e9335b80ddf/sphinxcontrib-swaggerui-0.0.5.tar.gz"
}
],
"0.0.6": [
{
"comment_text": "",
"digests": {
"md5": "6ebffbf589870b4193c467cb034200bf",
"sha256": "6f5637ae3e1688dc7eb177cb0da9385a3eb81ea2cec918cb9ad774fd8421bb5d"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6ebffbf589870b4193c467cb034200bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 211063,
"upload_time": "2019-08-21T14:33:37",
"url": "https://files.pythonhosted.org/packages/10/e7/c9829823d12e52f6b177efafc2a12e2244937aa95b7848de8785fff6b7fc/sphinxcontrib-swaggerui-0.0.6.tar.gz"
}
],
"0.0.7": [
{
"comment_text": "",
"digests": {
"md5": "cd27faa24ca8efc93a683a2fdf243787",
"sha256": "91230ae6a4f3af0f48bfafd6b5f788a9071d48df9d5158439474cd36653ddda0"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "cd27faa24ca8efc93a683a2fdf243787",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 56059,
"upload_time": "2019-08-22T12:49:56",
"url": "https://files.pythonhosted.org/packages/51/b6/701dd9621f8f6d294b0f7a14f442f6984ec71c3f18cee442e759d85498d9/sphinxcontrib-swaggerui-0.0.7.tar.gz"
}
],
"0.0.8": [
{
"comment_text": "",
"digests": {
"md5": "13d0bae82c61c67d4bcd6d584e29adcd",
"sha256": "ef3b0c1cd577cc933e203ea1c3bea4f7bbe6b921b958475d8fb21a899e72c661"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "13d0bae82c61c67d4bcd6d584e29adcd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 57484,
"upload_time": "2019-08-22T12:54:56",
"url": "https://files.pythonhosted.org/packages/a9/52/d8b0a4e2c133158ebb79ee40a0a58ae11365043f7ad54bfab29d14ff6977/sphinxcontrib-swaggerui-0.0.8.tar.gz"
}
],
"0.0.9": [
{
"comment_text": "",
"digests": {
"md5": "144c71cf10b2d938b26a95f724d587a0",
"sha256": "de24c2ad921e5fc9a881815f39a8c9dc4c1e1b5f11aef2112efe7f3f79d04ce0"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "144c71cf10b2d938b26a95f724d587a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 57849,
"upload_time": "2019-08-28T08:03:48",
"url": "https://files.pythonhosted.org/packages/dc/17/d28fd55f1b57abcdb6a649ccf8d8ea7364b83b586d3174866e38fb4083b0/sphinxcontrib-swaggerui-0.0.9.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "76d9a9ed75d9262312474561063750f8",
"sha256": "accb44764e387f986c3bc99690d70e21d4d438ccc3fec6cdee18ec7d5c80ae99"
},
"downloads": -1,
"filename": "sphinxcontrib-swaggerui-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "76d9a9ed75d9262312474561063750f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58285,
"upload_time": "2019-09-26T12:13:43",
"url": "https://files.pythonhosted.org/packages/cf/03/c973aa05ff6e3e8f0dcffc2d022769948edadf2e2d25ee81d68ad1d47c92/sphinxcontrib-swaggerui-0.0.10.tar.gz"
}
]
}