Metadata-Version: 2.4
Name: sphinx-openapi-renderer
Version: 0.1.0a1
Summary: Sphinx extension to render OpenAPI 3.1 Descriptions.
Keywords: sphinx,openapi,oapi,oai,oas,oad
Author: Javier Pérez
Author-email: Javier Pérez <walpo@noreply.codeberg.org>
License-Expression: LGPL-3.0-only
License-File: LICENSES/LGPL-3.0-only.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Classifier: Framework :: Sphinx :: Extension
Requires-Dist: openapi-spec-validator>=0.9,<0.10
Requires-Dist: ruamel-yaml>=0.19.1,<0.20
Requires-Dist: sphinx>=8
Requires-Dist: sphinxcontrib-httpdomain>=2,<3
Requires-Dist: m2r2
Requires-Dist: openapi-types
Requires-Python: >=3.12
Project-URL: source, https://codeberg.org/walpo/sphinx-openapi-renderer
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: 2026 Javier Pérez <walpo@noreply.codeberg.org>

SPDX-License-Identifier: CC-BY-SA-4.0
-->

# 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:

```bash
pip install sphinx-openapi-renderer
```

Add the extension to the Sphinx configuration file (`conf.py`):

```python
extensions = [
  # Your other extensions.
  # (...)
  "sphinx_openapi_renderer",
]
```

## Notes

- The behavior when resolving `$ref` fields 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`, `anyOf` and `allOf` keywords are not supported.
