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.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac13232afe8caffac715bfb2f74e5cc027fa855b2d6cf31731f9ac5875ce6f1c |
|
MD5 | 995b0f9923136e2c771ca15cdc64cf2f |
|
BLAKE2b-256 | 9e020a574d0e6b37f1593d839fa8d4fb066ea6e95a8e08460cab63f202e0c754 |