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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b8106641b5b3abb90ca21db5a0b2956a91bfac61212075854efdcabb6139c12 |
|
MD5 | 1421afb9e695b4bd13cb7919b983fc17 |
|
BLAKE2b-256 | d8dff23588b8a9d594ff308576abffdd7aa7891555c21be41c1b0bf19e83ca3c |