Skip to main content

Sphinx extension to generate JavaScript-driven redirects for moved pages

Project description

This contrib extension, sphinxcontrib.redirects, provides a Sphinx extension for generating JavaScript-driven redirects for moved pages. It currently only supports the html builder (


To enable the extension, you should add it to your file:

extensions = [

The extension relies on a redirect file. This defaults to redirects within the source directory but it can be overridden. To override this value, add the following to your file:

redirects_file = '<path to redirects file>'

The redirect file is a simple space-separated file of old_path - new_path pairs. These paths are relative to the source directory and should include their extension. For example, if you renamed the file test.rst to testing.rst then you could write:

test.rst testing.rst

This works for files moved between directories too. If you moved a test.rst to testing/index.rst instead, then you could write:

test.rst testing/index.rst

For examples, refer to the samples used in the tests.


For information on contributing, refer to the contributing guide.

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

sphinxcontrib-redirects-0.1.0.tar.gz (7.2 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_redirects-0.1.0-py3-none-any.whl (5.6 kB view hashes)

Uploaded Python 3

Supported by

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