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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc28176eb317d3686ff5958a30c12fce8ca3cb24800faebc80111263dc85eecc |
|
MD5 | a9a4f176fe757d3215e76981f735b904 |
|
BLAKE2b-256 | f799768c401ad7ad6b12f9ce31283a31fe52138fc98600a68279b9e82e1c51fa |