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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 411da1819fda0593976a157f1a14ec1cfaef9ee1b4b708e795d0bf3953f0142b |
|
MD5 | 8b6497284240fbfc4496618a2830d948 |
|
BLAKE2b-256 | 5f3219cd5a27b9328948d81d48b1569f4a39c6a6cb4dff92613c8b4ab81b5083 |