Pre-release
This release is a pre-release and may not be stable for production use.
sphinx-openapi-renderer
This is a Sphinx extension which allows you to render OpenAPI 3.1 Descriptions in your documentation.
Installation
Install the extension from PyPI:
pip install sphinx-openapi-renderer
Add the extension to the Sphinx configuration file (conf.py):
extensions = [
# Your other extensions.
# (...)
"sphinx_openapi_renderer",
]
Notes
- The behavior when resolving
$reffields is to use values only from the referenced object. If the referencing object has any supplementary fields to$ref, they will be ignored.
Limitations
- Multi-file OpenAPI Descriptions are not supported. Use single-file descriptions instead.
- Only version 3.1 of the OpenAPI Specification is supported for now.
- The
oneOf,anyOfandallOfkeywords are not supported.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_openapi_renderer-0.1.0a1.tar.gz.
File metadata
- Download URL: sphinx_openapi_renderer-0.1.0a1.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d7568d45ea14fbbfdfcfde0400f7c4b8142016d5ea8b9825d847651667e0eae
|
|
| MD5 |
0127ad8ffa6ec933acfc4c199b5c9b28
|
|
| BLAKE2b-256 |
ed6b2729015fcdd99ddb7160ed6a6fe52bf6189bdef8973fb566a235848897e6
|
File details
Details for the file sphinx_openapi_renderer-0.1.0a1-py3-none-any.whl.
File metadata
- Download URL: sphinx_openapi_renderer-0.1.0a1-py3-none-any.whl
- Upload date:
- Size: 16.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a51ddf5d91ec026ab576c9e3a2b56187edde399050641ae4baeec8b5816b1fe
|
|
| MD5 |
824731915a4b34a3ccfc721cb929b873
|
|
| BLAKE2b-256 |
e883a4b35d056b8b3cd84b5112565df21f09df0107812ba8645ebe1ac5acd084
|
