Skip to main content

Handles redirects for moved pages in Sphinx documentation projects

Project description

https://img.icons8.com/wired/64/undefined/forward-arrow--v1.png https://gitlab.com/documatt/sphinx-reredirects/badges/master/pipeline.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 domain https://techwriter.documatt.com.

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

Uploaded Source

Built Distribution

sphinx_reredirects-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_reredirects-0.1.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for sphinx_reredirects-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4519a45d316c921c46327b72fe410e1e7a32fe51694741296020b0ca008fbcee
MD5 fec204611dc9c4b2bd8b997393104d88
BLAKE2b-256 b53a195268759a3ff138f2ff32d6535f94cb9199671ed4832142a6a1d6f1a3fa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fab84a6e859db462c7d79eb03043eeea8d5efe1c3d078ad05e097f8b17f45641
MD5 a61aa99b3f10eeef64ffdcb508076c28
BLAKE2b-256 bdd35b71d61d5584e39d5f1c67bab0f6d1f862760aa412ed9dcd24f8bd9d26b4

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