sphinx-reredirects

sphinx-reredirects is the extension for Sphinx documentation projects that handles 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.

Table of Contents

Install and setup
Usage
FAQ
Release notes

Install and setup¶

Perform:

pip3 install sphinx-reredirects

Then, open your conf.py and append sphinx_reredirects to the extensions list:

extensions = [
    ...
    'sphinx_reredirects'
]

Previous: sphinx-reredirects | Next: Usage