Skip to content

Add information on using graph based redirects #8396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add information on using graph based redirects #8396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/user-defined-redirects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,15 @@ If you switch between *HTMLDir* and *HTML*, your URL's will change.
A page at ``/en/latest/install.html`` will be served at ``/en/latest/install/``,
or vice versa.
The built in redirects for this will handle redirecting users appropriately.

Redirects via an Extension
~~~~~~~~~~~~~~~~~~~~~~~~~~

Redirects are also possible via Sphinx extensions. One example of this is the
`sphinxext-rediraffe <https://github.com/wpilibsuite/sphinxext-rediraffe>`__
extension. This extension enables a "graph" style redirect system that is
useful for making pages "permanent" (dead links will always redirect). The
extension can be enabled by adding ``sphinxext-rediraffe`` to your
``requirements.txt`` file at the root of your directory and `enabling
<https://www.sphinx-doc.org/en/master/usage/extensions/index.html>`__
in the ``conf.py`` file.