sphinxext-rediraffe
Sphinx Extension that redirects non-existent pages to working pages
Decision gist · record as of 2026-08-14
Yes, if you maintain Sphinx documentation and need to handle page renames or deletions gracefully. The low install friction, permissive license, and stable status make it a straightforward addition. The aging maintenance signal (320 days since last release) is a minor concern but not a blocker—the repository is active and the extension's scope is narrow and stable. No known vulnerabilities.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx and Python 3.9 or later; only works with html and dirhtml builders.
- Low friction: pure Python wheel with only Sphinx as a runtime dependency.
- Maintenance signal is aging—last release was 320 days ago—but the repository remains active and not archived, with recent commits as of 2025-09-28.
License · maintenance · safety
MIT (permissive) — MIT license is permissive; you can use, modify, and distribute this package with minimal restrictions, provided you retain the license notice.
last release 2025-09-28 (320 days) · last repo commit 2025-09-28 · 39 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 257,139 downloads/mo, #8,449 on PyPI
Alternatives
Verify before relying
pip install sphinxext-rediraffe
# In conf.py:
extensions = ['sphinxext.rediraffe']
rediraffe_redirects = {
'old_page': 'new_page',
}- How redirect chains are configured and whether the graph traversal is automatic or requires explicit setup.
- Whether the git repo check for deleted/renamed files is a separate command or integrated into the build process.
- Performance impact when handling large numbers of redirects.
- Whether broken external links are prevented or just handled after the fact.
What it is and what it does
Sphinxext-rediraffe is a Sphinx extension that handles documentation page redirects—when a page is deleted or renamed, it automatically redirects users to the correct location. Instead of letting broken links accumulate, you define a mapping of old page paths to new ones, and the extension ensures that any request for an old page lands on the current version. The extension also resolves redirect chains: if page A redirects to page B and page B redirects to page C, all requests go directly to page C, so users experience only one redirect rather than multiple hops.
The extension works with Sphinx's html and dirhtml builders and can optionally check your git repository to verify that deleted or renamed files have corresponding redirects defined. It's a lightweight addition to your Sphinx setup—it only depends on Sphinx itself—and supports Python 3.9 through 3.13. The project is marked Production/Stable and has been maintained since 2020, though releases have slowed recently.
Use it for
- Redirect old documentation URLs after a site restructure to prevent broken links and preserve search rankings.
- Automatically handle renamed pages during documentation refactoring without breaking external links.
- Verify that all deleted documentation pages have redirect rules defined in your build process.
- Simplify user experience by eliminating redirect chains when documentation undergoes multiple reorganizations.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain Sphinx documentation and need to handle page renames or deletions gracefully.
The low install friction, permissive license, and stable status make it a straightforward addition. The aging maintenance signal (320 days since last release) is a minor concern but not a blocker—the repository is active and the extension's scope is narrow and stable. No known vulnerabilities.
Install
sphinxext-rediraffe on PyPI
Before you install
Low friction: pure Python wheel with only Sphinx as a runtime dependency. Maintenance signal is aging—last release was 320 days ago—but the repository remains active and not archived, with recent commits as of 2025-09-28.
Requires Sphinx and Python 3.9 or later; only works with html and dirhtml builders.
License in practice
MIT license is permissive; you can use, modify, and distribute this package with minimal restrictions, provided you retain the license notice.
Quickstart
pip install sphinxext-rediraffe
# In conf.py:
extensions = ['sphinxext.rediraffe']
rediraffe_redirects = {
'old_page': 'new_page',
}Verify before relying
- How redirect chains are configured and whether the graph traversal is automatic or requires explicit setup.
- Whether the git repo check for deleted/renamed files is a separate command or integrated into the build process.
- Performance impact when handling large numbers of redirects.
- Whether broken external links are prevented or just handled after the fact.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packageSphinx |
| Maintenance | Aging 320 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 257,139 / month, #8,449 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: PluginsEnvironment :: Web EnvironmentFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: DocumentationTopic :: Text ProcessingTopic :: Utilities |
Evidence: sphinxext_rediraffe-0.3.0-py3-none-any.whl
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 › “sphinx redirect pages”
- sphinxext-rediraffeA Sphinx extension that automatically redirects requests for…
- sphinx-reredirectsSphinx extension that generates HTML redirect pages with meta refresh…
- mkdocs-redirectsA MkDocs plugin that generates HTTP redirects for moved or renamed…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also sphinx-reredirects · mkdocs-redirects · sphinx-remove-toctrees · sphinx-last-updated-by-git · sphinxext-opengraph · sphinx-notfound-page · sphinx-needs · sphinx-llm · sphinx-issues · sphinx-automodapi