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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808aa2f915728efc7ccaf12567199616311e6df7327709221058d4406711538b |
|
MD5 | 8305436228d0e925c9be32f906d87ce4 |
|
BLAKE2b-256 | 7de35ee1d940816cf077d445fe424a91b58a7e3698d7ca1de2da9bf078102769 |
Close
Hashes for sphinxcontrib_openapi-0.8.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62f9f02a0dd986c316f9c01be62af5e67a88245dfa6703e02577395e39f0b5c9 |
|
MD5 | 0417f65d70eed64cc6c33dca1c16cfa5 |
|
BLAKE2b-256 | 690a3ff627173d4e0f1013996026332fc88f6b01d80d917f235dc15bb4e84392 |