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:
This works for files moved between directories too. If you moved a test.rst to testing/index.rst instead, then you could write:
For examples, refer to the samples used in the tests.
For information on contributing, refer to the contributing guide.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for sphinxcontrib-redirects-0.1.0.tar.gz
Hashes for sphinxcontrib_redirects-0.1.0-py3-none-any.whl