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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aced6a9684ce814e6a54751133203a520eeb0b750e8c80aa3d488527d46c2f30 |
|
MD5 | eecee503af05d7429b7c3309cfddd866 |
|
BLAKE2b-256 | 62f018c0ffba458bd8a0db08e9d60e59b186f959a1814bacdbe2a7621ca7b987 |
Close
Hashes for sphinxcontrib_openapi-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9395b7cb607c956a2e4dd8ccfa9ce4718f954a599d20dce6acad9f4a5ff75a0d |
|
MD5 | ca7ffd77ec7685ec779a409437b798be |
|
BLAKE2b-256 | 60fbc9c5e6a52c92836783583f70c56200daf245bf05248f968e83c2e7c00fad |