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.
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
Close
Hashes for sphinxcontrib-openapi-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6637056dee847bc6aa79e0f4b42011665de6b679fbd723c9ccb05a7b068ed63b |
|
MD5 | 04a17bed1f180fbf0a85100750f41891 |
|
BLAKE2b-256 | 000e1534933c1a136af9d855a8815bb6db24ea9e4bc637316dc905e4e8bf20d2 |