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.
$ python3 -m pip install sphinxcontrib-openapiUsage
Pass sphinxcontrib-openapi to extensions list in Sphinx’s conf.py
extensions = [
...
'sphinxcontrib.openapi',
]and feel free to use the openapi directive to render OpenAPI specs
.. openapi:: path/to/openapi.ymlLinks
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-openapi 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib_openapi-0.10.0.tar.gz | 101.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_openapi-0.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 137.0 kB
Release files / sphinxcontrib_openapi-0.10.0.tar.gz
| Download URL | sphinxcontrib_openapi-0.10.0.tar.gz |
|---|---|
| Size | 101.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
beec8bf4ece8f28fb1b378e60914b92fed6e38009a60d915ed2cd0c023a54f6d
|
|
BLAKE2b-256 checksum How to use checksums |
8f3c869ac4df0440814d65ad1ebca27d758cf6e2a2639a4babc60ca710e29231
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / sphinxcontrib_openapi-0.10.0-py3-none-any.whl
| Download URL | sphinxcontrib_openapi-0.10.0-py3-none-any.whl |
|---|---|
| Size | 35.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
378624ec4e84aae7c1c5441d3c84295081972069e5a8188e84b2274e577fc9c5
|
|
BLAKE2b-256 checksum How to use checksums |
729a7438cfde2baa37132ab39b2d1d7ac3440baa44983bfc07c5df2637b16a64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
