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

Uploaded Source

Built Distribution

sphinx_reredirects-0.1.4-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_reredirects-0.1.4.tar.gz
  • Upload date:
  • Size: 6.4 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.4.tar.gz
Algorithm Hash digest
SHA256 b8effdb31a069823cd8b5b029bfe1e04ac584615a0ebea35c5a8c8daf05a354b
MD5 cb95121e9795288d7c22cc9fe9b6670d
BLAKE2b-256 496c25daf912644a515de5034409196cf314a60e9ecb0545d5d9d00b2d997d5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f27995e233a62336fc254330543d8b0f779ec83089da36274e27f5a5f2d5f529
MD5 3ce70c624afe75175c93e6da7df09da8
BLAKE2b-256 977e633e52dcbd4bce80405b97b6d1c959166423a85271c19a8f4f0b69576d88

See more details on using hashes here.

Supported by

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