sphinxcontrib-redoc
ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- 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.
- High install friction reported.
License · maintenance · safety
BSD (permissive) — BSD License (permissive). You may use, modify, and distribute this package freely in commercial and private projects, provided you include the license notice.
last release 2020-04-17 (2310 days) · last repo commit 2023-11-08 · 40 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 488,564 downloads/mo, #6,378 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-redoc
In conf.py:
extensions = ['sphinxcontrib.redoc']
In your .rst file:
.. redoc:: path/to/openapi.json- 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.
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 on it.
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
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.
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.
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.jsonVerify 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
| License | BSD permissive |
| Python support | Not specified |
| Install friction | High. Source build required |
| Runtime dependencies | None |
| Maintenance | Dormant 2,310 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 488,564 / month, #6,378 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Environment :: ConsoleIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 2Programming Language :: Python :: 2.7Programming Language :: Python :: 3Programming Language :: Python :: 3.5Programming Language :: Python :: 3.6Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Topic :: Documentation |
Evidence: sphinxcontrib-redoc-1.6.0.tar.gz
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “redoc swagger renderer”
- sphinxcontrib-redocA Sphinx extension that embeds OpenAPI specifications rendered with…
- drf-spectacular-sidecarServes pre-built Swagger UI and Redoc distributions as Django static…
- fastapi-offlineReplaces FastAPI's CDN-dependent documentation UI with locally-served…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also bidict · sphinxcontrib-openapi · swagger-plugin-for-sphinx · sanic-ext · sphinxcontrib-programoutput · aiohttp-swagger3 · django-rest-swagger · sphinxcontrib-video · drf-yasg · flask-openapi3-swagger