sphinxcontrib-openapi


Namesphinxcontrib-openapi JSON
Version 0.8.4 PyPI version JSON
download
home_pagehttps://github.com/sphinx-contrib/openapi
SummaryOpenAPI (fka Swagger) spec renderer for Sphinx
upload_time2024-02-13 10:46:10
maintainer
docs_urlNone
authorIhor Kalnytskyi
requires_python>=3.7
licenseBSD
keywords sphinx openapi swagger rest api renderer docs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =====================
sphinxcontrib-openapi
=====================

**sphinxcontrib-openapi** is a `Sphinx`_ extension to generate APIs docs from
`OpenAPI`_ (fka Swagger) spec. It depends on `sphinxcontrib-httpdomain`_ that
provides an HTTP domain for describing RESTful HTTP APIs, so we don't need to
reinvent the wheel.

.. code:: bash

   $ python3 -m pip install sphinxcontrib-openapi


Usage
=====

Pass ``sphinxcontrib-openapi`` to ``extensions`` list in  Sphinx's ``conf.py``

.. code:: python

   extensions = [
      ...
      'sphinxcontrib.openapi',
   ]

and feel free to use the ``openapi`` directive to render OpenAPI specs

.. code:: restructuredtext

   .. openapi:: path/to/openapi.yml


Links
=====

* Documentation: https://sphinxcontrib-openapi.readthedocs.org/
* Source: https://github.com/sphinx-contrib/openapi
* Bugs: https://github.com/sphinx-contrib/openapi/issues


.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _OpenAPI: https://github.com/OAI/OpenAPI-Specification
.. _sphinxcontrib-httpdomain: https://sphinxcontrib-httpdomain.readthedocs.io/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sphinx-contrib/openapi",
    "name": "sphinxcontrib-openapi",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "sphinx openapi swagger rest api renderer docs",
    "author": "Ihor Kalnytskyi",
    "author_email": "ihor@kalnytskyi.com",
    "download_url": "https://files.pythonhosted.org/packages/c0/a7/66a5c9aba7dbbb0c2b050f60e71402818cbf5f127ace13ed971029cc745e/sphinxcontrib-openapi-0.8.4.tar.gz",
    "platform": null,
    "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   $ python3 -m 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/sphinx-contrib/openapi\n* Bugs: https://github.com/sphinx-contrib/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/\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "OpenAPI (fka Swagger) spec renderer for Sphinx",
    "version": "0.8.4",
    "project_urls": {
        "Bugs": "https://github.com/sphinx-contrib/openapi/issues",
        "Documentation": "https://sphinxcontrib-openapi.readthedocs.io/",
        "Homepage": "https://github.com/sphinx-contrib/openapi",
        "Source": "https://github.com/sphinx-contrib/openapi"
    },
    "split_keywords": [
        "sphinx",
        "openapi",
        "swagger",
        "rest",
        "api",
        "renderer",
        "docs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d5c3ee00486f38d78309a60ee0d6031b2545b22ac5f0007d841dd174abc68774",
                "md5": "93bfb30f4859a56d35fbec619067aeb3",
                "sha256": "50911c18d452d9390ee3a384ef8dc8bde6135f542ba55691f81e1fbc0b71014e"
            },
            "downloads": -1,
            "filename": "sphinxcontrib_openapi-0.8.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93bfb30f4859a56d35fbec619067aeb3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 34510,
            "upload_time": "2024-02-13T10:46:09",
            "upload_time_iso_8601": "2024-02-13T10:46:09.271988Z",
            "url": "https://files.pythonhosted.org/packages/d5/c3/ee00486f38d78309a60ee0d6031b2545b22ac5f0007d841dd174abc68774/sphinxcontrib_openapi-0.8.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c0a766a5c9aba7dbbb0c2b050f60e71402818cbf5f127ace13ed971029cc745e",
                "md5": "f0edbf39fba4bf07b04de3e8eae80937",
                "sha256": "df883808a5b5e4b4113ad697185c43a3f42df3dce70453af78ba7076907e9a20"
            },
            "downloads": -1,
            "filename": "sphinxcontrib-openapi-0.8.4.tar.gz",
            "has_sig": false,
            "md5_digest": "f0edbf39fba4bf07b04de3e8eae80937",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 71848,
            "upload_time": "2024-02-13T10:46:10",
            "upload_time_iso_8601": "2024-02-13T10:46:10.663389Z",
            "url": "https://files.pythonhosted.org/packages/c0/a7/66a5c9aba7dbbb0c2b050f60e71402818cbf5f127ace13ed971029cc745e/sphinxcontrib-openapi-0.8.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-13 10:46:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sphinx-contrib",
    "github_project": "openapi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sphinxcontrib-openapi"
}
        
Elapsed time: 0.19106s