DOC: add redirects for new removed files

jklymak · jklymak · commit abeef9d82451 · 2021-02-04T21:00:58.000-08:00
diff --git a/doc/api/backend_gtk3agg_api.rst b/doc/api/backend_gtk3agg_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_gtk3_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_gtk3cairo_api.rst b/doc/api/backend_gtk3cairo_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_gtk3_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_qt4agg_api.rst b/doc/api/backend_qt4agg_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_qt_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_qt4cairo_api.rst b/doc/api/backend_qt4cairo_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_qt_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_qt5agg_api.rst b/doc/api/backend_qt5agg_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_qt_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_qt5cairo_api.rst b/doc/api/backend_qt5cairo_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_qt_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_tkagg_api.rst b/doc/api/backend_tkagg_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_tk_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/api/backend_wxagg_api.rst b/doc/api/backend_wxagg_api.rst
@@ -0,0 +1,2 @@
+This file has been moved to backend_gtk3_api.rst and will be redirected
+by the reredirects extension during the docs build.
diff --git a/doc/conf.py b/doc/conf.py
@@ -64,6 +64,7 @@
     'sphinxext.mock_gui_toolkits',
     'sphinxext.skip_deprecated',
     'sphinx_copybutton',
+    'sphinx_reredirects'
 ]
 
 exclude_patterns = [
@@ -484,6 +485,18 @@ def _check_dependencies():
 # graphviz_output_format = 'svg'
 
 
+# sphinx-reredirects
+# See https://gitlab.com/documatt/sphinx-reredirects/
+redirects = {
+    "api/backend_gtk3agg_api": "api/backend_gtk3_api.html",
+    "api/backend_gtk3cairo_api": "api/backend_gtk3_api.html",
+    "api/backend_qt*agg_api": "api/backend_qt_api.html",
+    "api/backend_qt*cairo_api": "api/backend_qt_api.html",
+    "api/backend_tkagg_api": "api/backend_tk_api.html",
+    "api/backend_wxagg_api": "api/backend_wx_api.html",
+}
+
+
 def setup(app):
     if any(st in version for st in ('post', 'alpha', 'beta')):
         bld_type = 'dev'
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -15,4 +15,5 @@ numpydoc>=0.8
 sphinxcontrib-svg2pdfconverter>=1.1.0
 sphinx-gallery>=0.7
 sphinx-copybutton
+sphinx-reredirects
 scipy

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+This file has been moved to backend_gtk3_api.rst and will be redirected`
	`2`	`+by the reredirects extension during the docs build.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+This file has been moved to backend_qt_api.rst and will be redirected`
	`2`	`+by the reredirects extension during the docs build.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+This file has been moved to backend_tk_api.rst and will be redirected`
	`2`	`+by the reredirects extension during the docs build.`