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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04fcf87c259345162a504ce3dfee0f71389f507c3797798dc531c7748995b4eb |
|
MD5 | 59fe10f679765317528d204c30a743a9 |
|
BLAKE2b-256 | cd5b060ab6849defc1f938b6f391bbf569d226342d319db99488b3fc8cd7dbf1 |
Close
Hashes for sphinxcontrib_openapi-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45ecad2a98e304d3665c133ea08a7083a2b5d86e75c6b64c60389240b3927ad5 |
|
MD5 | bd79bda862f859ba76060e4f910521b6 |
|
BLAKE2b-256 | 0c37ed9179f818b296fd722c865b644068772829ea291b35fd15748cce0b65f3 |