Skip to content

Commit f851149

Browse files
committed
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 <[email protected]>
1 parent 8ebd52e commit f851149

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

requirements-doc.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ sphinx-design==0.6.0
33
sphinx-copybutton==0.5.2
44
sphinx-tags==0.4
55
sphinx-toolbox==3.7.0
6+
sphinx-reredirects==0.1.5
67
myst-parser==3.0.1
78
# FIXME: Using fork in order to enable the 'collapse_navbar=True'
89
# option for the sphinx-theme. Upstream proposal:

sources/pyside6/doc/conf.py.in

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.ifconfig',
3131
'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude',
3232
'sphinx.ext.viewcode',
3333
'sphinx_design', 'sphinx_copybutton', 'myst_parser', 'sphinx_tags',
34-
'sphinx_toolbox.decorators']
34+
'sphinx_toolbox.decorators', 'sphinx_reredirects']
3535

3636
myst_enable_extensions = [
3737
"amsmath",
@@ -242,3 +242,14 @@ tags_create_badges = True
242242
tags_badge_colors = {
243243
"Android": "info",
244244
}
245+
246+
# link redirection in sphinx
247+
redirects = {
248+
"gettingstarted/porting_from2.html": "../faq/porting_from2.html",
249+
"gettingstarted/package_details.html": "../package_details.html",
250+
"gettingstarted/index.html": "../building_from_source/index.html",
251+
"gettingstarted/linux.html": "../building_from_source/linux.html",
252+
"gettingstarted/windows.html": "../building_from_source/windows.html",
253+
"gettingstarted/macOS.html": "../building_from_source/macOS.html",
254+
"quickstart.html": "gettingstarted.html"
255+
}

0 commit comments

Comments
 (0)