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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_reredirects-0.1.3.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sphinx_reredirects-0.1.3.tar.gz
Algorithm Hash digest
SHA256 56e222d285f76c944fd370f36ad3a1a66103a88b552e97d3d24a622bb9465de8
MD5 015c1567f9d3c6f85a90509813a8445a
BLAKE2b-256 e15d3640714ba044e1998877fea6e49b832eb0eeae2204c78a2167f96f274df4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 02c53437c467cf9ed89863eff3addedc01d129624b2f03ab6302518fb77a2c89
MD5 305ca555659c377e75da5595e659e615
BLAKE2b-256 4360717acd88eca89e2f4153b0a1cea41b4db3924e046853a36bab8c9b93e070

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