Skip to content

Commit

Permalink
doc: fix broken Sphinx by updating to Sphinx 5.0.2
Browse files Browse the repository at this point in the history
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é <benjamin@zephyrproject.org>
  • Loading branch information
kartben authored and cfriedt committed Mar 1, 2024
1 parent e9fcfa1 commit 3683fe6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,8 @@
# -- Linkcheck options ----------------------------------------------------

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

linkcheck_timeout = 30
Expand Down
2 changes: 1 addition & 1 deletion scripts/requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# DOC: used to generate docs

breathe>=4.30
sphinx~=4.0
sphinx~=5.0.2
sphinx_rtd_theme~=1.0
sphinx-tabs
sphinxcontrib-svg2pdfconverter
Expand Down

0 comments on commit 3683fe6

Please sign in to comment.