aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc
diff options
context:
space:
mode:
authorShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-08-09 10:58:02 +0200
committerShyamnath Premnadh <Shyamnath.Premnadh@qt.io>2024-08-14 13:52:40 +0200
commitf85114909d0ba91ecbe8dfa484cab359502e9cd4 (patch)
tree61acf482440b72209ebc571826e33e45a631ca85 /sources/pyside6/doc
parent8ebd52ed5033464bce399ea1b2e0bfdff60ea518 (diff)
Docs: Add html redirects
- Since some .rst folders were renamed and reaaranged, this broke some existing links i.e. quickstart.html does not exist anymore since it was renamed to gettingstarted.html - This patch establishes redirects so that the old changed html links still exists and redirect to the new links. For this a new dependency of sphinx_reredirects is added. Task-number: PYSIDE-2837 Change-Id: I7af4a1ffef174b06fd8cb439ad1ccf52754c744d Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc')
-rw-r--r--sources/pyside6/doc/conf.py.in13
1 files changed, 12 insertions, 1 deletions
diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in
index e195d227f..0e4615994 100644
--- a/sources/pyside6/doc/conf.py.in
+++ b/sources/pyside6/doc/conf.py.in
@@ -31,7 +31,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig',
'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude',
'sphinx.ext.viewcode',
'sphinx_design', 'sphinx_copybutton', 'myst_parser', 'sphinx_tags',
- 'sphinx_toolbox.decorators']
+ 'sphinx_toolbox.decorators', 'sphinx_reredirects']
myst_enable_extensions = [
"amsmath",
@@ -242,3 +242,14 @@ tags_create_badges = True
tags_badge_colors = {
"Android": "info",
}
+
+# link redirection in sphinx
+redirects = {
+ "gettingstarted/porting_from2.html": "../faq/porting_from2.html",
+ "gettingstarted/package_details.html": "../package_details.html",
+ "gettingstarted/index.html": "../building_from_source/index.html",
+ "gettingstarted/linux.html": "../building_from_source/linux.html",
+ "gettingstarted/windows.html": "../building_from_source/windows.html",
+ "gettingstarted/macOS.html": "../building_from_source/macOS.html",
+ "quickstart.html": "gettingstarted.html"
+}