sphinx-reredirects
The extension for Sphinx documentation projects that handle redirects for moved pages. It generates HTML pages with meta refresh redirects to the new page location to prevent 404 errors if you rename or move your documents.
Decision gist · record as of 2026-08-14
Yes, if you maintain a Sphinx documentation site and need to handle URL changes. The extension is actively maintained, has low install friction, and solves a real problem with minimal configuration. The only caveat is that license metadata is unclear—verify the MIT claim before use in contexts where license certainty matters.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.11 or later and Sphinx as a dependency; client-side redirects require JavaScript enabled in browsers.
- Low friction install as a pure Python wheel with only Sphinx as a runtime dependency.
- Actively maintained with recent releases; last commit 2026-02-27 and latest release 2025-12-22.
License · maintenance · safety
(unclear) — License treatment is unclear in the package metadata, though the description references MIT licensing. Verify the actual license terms before use in proprietary or restricted contexts.
last release 2025-12-22 (235 days) · last repo commit 2026-02-27 · 16 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 894,004 downloads/mo, #4,794 on PyPI
Alternatives
Verify before relying
pip install sphinx-reredirects
# In conf.py:
extensions = ['sphinx_reredirects']
redirects = {
'old_page': 'new_page.html',
'docs/old/*': 'docs/new/',
}- Whether the MIT license claim in the description is authoritative or whether metadata omission indicates a different license
- Wildcard matching and cross-domain redirect behavior details beyond the description's summary
- Whether dynamic placeholders support variable substitution or simple string replacement
What it is and what it does
sphinx-reredirects is a Sphinx extension that automates the creation of redirect pages when you rename or move documentation files. Instead of leaving broken links, it generates lightweight HTML files with meta refresh tags that send visitors to the new location—all configured from a single place in your project's conf.py file. It requires no server-side setup, works across domains, and supports wildcard patterns for bulk redirects.
The extension solves the common problem of maintaining documentation URLs as your site evolves. When you rename a page from `start.html` to `intro.html`, sphinx-reredirects generates a `start.html` that automatically redirects browsers to the new location. This keeps search engine rankings intact and prevents 404 errors for bookmarked or externally linked pages.
Use it for
- Rename documentation pages without breaking external links or search engine indexing
- Move entire documentation sections to new locations with wildcard redirect rules
- Migrate a documentation site to a different domain while preserving old URLs
- Maintain backward compatibility when reorganizing a large documentation structure
- Centralize all redirect logic in conf.py instead of managing .htaccess or server config
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain a Sphinx documentation site and need to handle URL changes.
The extension is actively maintained, has low install friction, and solves a real problem with minimal configuration. The only caveat is that license metadata is unclear—verify the MIT claim before use in contexts where license certainty matters.
Install
sphinx-reredirects on PyPI
Before you install
Low friction install as a pure Python wheel with only Sphinx as a runtime dependency. Actively maintained with recent releases; last commit 2026-02-27 and latest release 2025-12-22.
Requires Python 3.11 or later and Sphinx as a dependency; client-side redirects require JavaScript enabled in browsers.
License in practice
License treatment is unclear in the package metadata, though the description references MIT licensing. Verify the actual license terms before use in proprietary or restricted contexts.
Quickstart
pip install sphinx-reredirects
# In conf.py:
extensions = ['sphinx_reredirects']
redirects = {
'old_page': 'new_page.html',
'docs/old/*': 'docs/new/',
}
Verify before relying
- Whether the MIT license claim in the description is authoritative or whether metadata omission indicates a different license
- Wildcard matching and cross-domain redirect behavior details beyond the description's summary
- Whether dynamic placeholders support variable substitution or simple string replacement
Package facts
| License | Not declared unclear |
| Python support | Supports the current Python release >=3.11 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Actively maintained 235 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 894,004 / month, #4,794 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: Python :: 3Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: DocumentationTopic :: Utilities |
Evidence: sphinx_reredirects-1.1.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 › “handle moved pages sphinx”
- sphinx-reredirectsSphinx extension that generates HTML redirect pages with meta refresh…
- sphinxext-rediraffeA Sphinx extension that automatically redirects requests for…
- sphinx-autosummary-accessorsA Sphinx extension that generates proper documentation for pandas or…
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-notfound-page · sphinxcontrib-googleanalytics · sphinxext-rediraffe · bidict · mkdocs-redirects · sphinx-favicon · sphinx-last-updated-by-git · sphinx-remove-toctrees · sphinxext-opengraph · sphinx-hoverxref