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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_reredirects-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 c491cba545f67be9697508727818d8626626366245ae64456fe29f37e9bbea64
MD5 5dc272411b65ccf838bdac86264ac945
BLAKE2b-256 166bbcca2785de4071f604a722444d4d7ba8a9d40de3c14ad52fce93e6d92694

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 efd50c766fbc5bf40cd5148e10c00f2c00d143027de5c5e48beece93cc40eeea
MD5 ffa7e7a9720f4d35d664547ad76e91eb
BLAKE2b-256 ac6f0b3625be30a1a50f9e4c2cb2ec147b08f15ed0e9f8444efcf274b751300b

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