Skip to main content

Handles redirects for moved pages in Sphinx documentation projects

Project description

https://raw.githubusercontent.com/documatt/sphinx-reredirects/main/logo.png https://github.com/documatt/sphinx-reredirects/actions/workflows/tests.yml/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/pypi/v/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.

Good URLs are never changing URLs. But if you must, sphinx-reredirects helps you manage redirects with ease and from the single place in project’s conf.py. For example, if you rename document start to intro, and tell it to sphinx-reredirects, it will generate HTML page start.html with <meta http-equiv="refresh" content="0; url=intro.html">. The extension supports wildcards and moving to different domain too.

About

sphinx-reredirects started from the urge to manage redirects for all documents during moving our Tech writer at work blog to the new address at https://documatt.com/blog/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_reredirects-0.1.3.tar.gz (6.4 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page