sphinxcontrib-redoc

What it is and what it does

sphinxcontrib-redoc is a Sphinx extension that lets you embed OpenAPI specifications directly into your Sphinx documentation, rendering them with ReDoc—a popular, interactive API documentation viewer. Instead of maintaining separate API docs, you point the extension to your OpenAPI JSON or YAML file, and it generates a styled, browsable API reference as part of your main documentation site.

The extension is designed for teams moving to OpenAPI and wanting a unified documentation experience. It has no runtime dependencies beyond Sphinx itself, making it lightweight to add to an existing doc build. However, the project is dormant: the last release was in April 2020, and the repository shows no recent activity. This means it may not work reliably with modern Python versions or current Sphinx releases without troubleshooting.

Use it for:

• Embed an OpenAPI spec into Sphinx docs so API consumers see the full API reference alongside conceptual documentation.
• Migrate from Swagger UI to ReDoc rendering while keeping your documentation in Sphinx.
• Generate interactive API docs from an OpenAPI file without maintaining a separate documentation site.
• Include multiple API specs in a single Sphinx project, each rendered with ReDoc in its own section.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that embeds OpenAPI specifications rendered with ReDoc directly into Sphinx documentation sites.

No. The package is dormant (last release April 2020, no commits since November 2023) and classifiers suggest it targets Python 3.8 and earlier. Compatibility with modern Python versions and current Sphinx is unverified. If you need to embed OpenAPI specs in Sphinx docs, consider actively maintained alternatives or rendering ReDoc separately and linking to it instead.

Install

sphinxcontrib-redoc on PyPI

pip install sphinxcontrib-redoc

uv add sphinxcontrib-redoc

poetry add sphinxcontrib-redoc

Installing sphinxcontrib-redoc

Before you install

High install friction reported. The package is dormant—last release was 2020-04-17, over 2310 days ago, with no recent commits. Classifiers list Python 2.7 and 3.5–3.8, suggesting it may not be tested or maintained for current Python versions.

License in practice

BSD License (permissive). You may use, modify, and distribute this package freely in commercial and private projects, provided you include the license notice.

Quickstart

pip install sphinxcontrib-redoc

In conf.py:
extensions = ['sphinxcontrib.redoc']

In your .rst file:
.. redoc:: path/to/openapi.json

Requires Sphinx to be installed and configured. Package classifiers indicate Python 2.7 and 3.5–3.8 support, but dormant status means compatibility with modern Python versions is unverified.

Verify before relying

• Whether the package works with Python 3.9, 3.10, 3.11, or later versions despite classifiers listing only up to 3.8.
• Whether ReDoc rendering works correctly with current versions of Sphinx and modern web standards.
• Whether the package has any undisclosed dependencies beyond Sphinx itself.

Package facts

Evidence: sphinxcontrib-redoc-1.6.0.tar.gz

Keywords: sphinx, openapi, swagger, rest, api, renderer, docs, redoc

Tags

More Documentation packages