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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c62117540b5276006ac7ad4af34696d02af278afa299712740c3680a9a9de6c |
|
MD5 | 8e1ddad1bfa14fa82ad1743bda5e67f0 |
|
BLAKE2b-256 | afcd9891f1c361b306e9f5e423039bdbf99a25c838c51ac820c10e986582c29a |
Close
Hashes for sphinxcontrib_openapi-0.8.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f7ac93ff71487c6c0521bde1caad452070d39c9d8d5af324ee02dcdc465392f |
|
MD5 | d7834b532fd3a1d9522407a617d2f23a |
|
BLAKE2b-256 | 75167187f68f8834ab455ddb6de1fcfa36896c0df714eb32c76a78f212a10780 |