Skip to content

Commit 3683fe6

Browse files
kartbencfriedt
authored andcommitted
doc: fix broken Sphinx by updating to Sphinx 5.0.2
Sphinx 4.x is way past EOL and due to it not pinning its dependencies, it's effectively broken. See sphinx-doc/sphinx#11890 The recommended fix, although not ideal in the context of an LTS branch, is to update to Sphinx 5.0.2, which should have minimal impact of how the rendered documentation looks. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent e9fcfa1 commit 3683fe6

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@
253253
# -- Linkcheck options ----------------------------------------------------
254254

255255
extlinks = {
256-
"jira": ("https://jira.zephyrproject.org/browse/%s", ""),
257-
"github": ("https://github.com/zephyrproject-rtos/zephyr/issues/%s", ""),
256+
"jira": ("https://jira.zephyrproject.org/browse/%s", "JIRA %s"),
257+
"github": ("https://github.com/zephyrproject-rtos/zephyr/issues/%s", "GitHub #%s"),
258258
}
259259

260260
linkcheck_timeout = 30

scripts/requirements-doc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# DOC: used to generate docs
22

33
breathe>=4.30
4-
sphinx~=4.0
4+
sphinx~=5.0.2
55
sphinx_rtd_theme~=1.0
66
sphinx-tabs
77
sphinxcontrib-svg2pdfconverter

0 commit comments

Comments
 (0)