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.5.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

sphinx_reredirects-0.1.5-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_reredirects-0.1.5.tar.gz.

File metadata

  • Download URL: sphinx_reredirects-0.1.5.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.7

File hashes

Hashes for sphinx_reredirects-0.1.5.tar.gz
Algorithm Hash digest
SHA256 cfa753b441020a22708ce8eb17d4fd553a28fc87a609330092917ada2a6da0d8
MD5 867f45b10a0f106f30a9eefeaa9c50f0
BLAKE2b-256 f91db1229d825a418738ce1a03930629a7b873cd6a0ff05953493604de35a3d5

See more details on using hashes here.

File details

Details for the file sphinx_reredirects-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 444ae1438fba4418242ca76d6a6de3eaee82aaf0d8f2b0cac71a15d32ce6eba2
MD5 c4a79c6db31d874335878ddf1720cbb4
BLAKE2b-256 34971f8143f87330f4c9ccc2c08ae9cd3cb1ce2944c51e98dd7ff141154fbcc7

See more details on using hashes here.

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