sphinxcontrib-redirects 0.2.0

Usage

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

extensions = [
    'sphinxcontrib.redirects',
    ...
]

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 conf.py 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.

Contributing

For information on contributing, refer to the contributing guide.