OpenAPI (fka Swagger) spec renderer for Sphinx
Project description
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-openapi
Usage
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.yml
Links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-openapi-0.8.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | df883808a5b5e4b4113ad697185c43a3f42df3dce70453af78ba7076907e9a20 |
|
MD5 | f0edbf39fba4bf07b04de3e8eae80937 |
|
BLAKE2b-256 | c0a766a5c9aba7dbbb0c2b050f60e71402818cbf5f127ace13ed971029cc745e |
Close
Hashes for sphinxcontrib_openapi-0.8.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50911c18d452d9390ee3a384ef8dc8bde6135f542ba55691f81e1fbc0b71014e |
|
MD5 | 93bfb30f4859a56d35fbec619067aeb3 |
|
BLAKE2b-256 | d5c3ee00486f38d78309a60ee0d6031b2545b22ac5f0007d841dd174abc68774 |