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-openapiUsage
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.ymlLinks
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
sphinxcontrib-openapi-0.5.0.tar.gz
(171.8 kB
view details)
File details
Details for the file sphinxcontrib-openapi-0.5.0.tar.gz.
File metadata
- Download URL: sphinxcontrib-openapi-0.5.0.tar.gz
- Upload date:
- Size: 171.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2a5883456c0caba0dad90f07968c75a50d5fc425a3aa06d1c538472ddf8c7e22 |
|
| MD5 | 4ed822b461d4b01af1a5ed63afe8ed42 |
|
| BLAKE2b-256 | 97a324cd0028774c75482ec11ed35ebfbb125ed882f84987811799ee23ead11e |
