Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix broken Sphinx by updating to Sphinx 5.0.2 #69654

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Mar 1, 2024

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.

Fixes #69656.

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]>
@kartben kartben linked an issue Mar 1, 2024 that may be closed by this pull request
@kartben kartben marked this pull request as ready for review March 1, 2024 10:02
@kartben kartben requested review from galak and nashif as code owners March 1, 2024 10:02
@kartben kartben added LTS Long term release branch related area: Documentation Infrastructure labels Mar 1, 2024
@nordicjm nordicjm requested a review from cfriedt March 1, 2024 10:43
@cfriedt cfriedt added the Hotfix Fix for issues blocking development, i.e. CI issues, tests failing in CI, etc. label Mar 1, 2024
@cfriedt cfriedt merged commit 3683fe6 into zephyrproject-rtos:v2.7-branch Mar 1, 2024
14 checks passed
@kartben kartben deleted the fix_lts_doc branch March 18, 2024 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Infrastructure Hotfix Fix for issues blocking development, i.e. CI issues, tests failing in CI, etc. LTS Long term release branch related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation build using Sphinx 4.x is broken on LTS2 branch
3 participants