diff --git a/requirements.txt b/requirements.txt --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,7 @@ sphinxcontrib-images sphinxcontrib-programoutput sphinx-tabs +sphinx-reredirects sphinx_rtd_theme sphinx-click myst-parser diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py --- a/swh/docs/sphinx/conf.py +++ b/swh/docs/sphinx/conf.py @@ -31,6 +31,7 @@ "sphinx_click.ext", "myst_parser", "sphinx.ext.todo", + "sphinx_reredirects", "swh.docs.sphinx.view_in_phabricator", ] @@ -125,6 +126,15 @@ # refer to the Python standard library. intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} +# Redirects for pages that were moved, so we don't break external links. +# Uses sphinx-reredirects +redirects = { + "swh-deposit/spec-api": "api/api-documentation.html", + "swh-deposit/metadata": "api/metadata.html", + "swh-deposit/specs/blueprint": "../api/use-cases.html", + "swh-deposit/user-manual": "api/user-manual.html", +} + # -- autodoc configuration ---------------------------------------------- autodoc_default_flags = [