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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx_reredirects-0.1.2.tar.gz
Algorithm Hash digest
SHA256 a0e7213304759b01edc22f032f1715a1c61176fc8f167164e7a52b9feec9ac64
MD5 10aed8deb8fce52ce7e031d5a14703e7
BLAKE2b-256 8007a0e4cda9584460e187aee74fe46d3b145e5320d13d4ae7dadc577e7a9d47

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_reredirects-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3a22161771aadd448bb608a4fe7277252182a337af53c18372b7104531d71489
MD5 e9b5d46b323abf0bbbc8d0c155f507ce
BLAKE2b-256 682b62d27b08813d5fdc05349b2ad265f4e47d847805bfcd10df384e4473b1b6

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page