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: Do not use Sphinx 5.2.0.post0 #50624

Merged

Conversation

stephanosio
Copy link
Member

Sphinx 5.2.0.post0 release has a known compatibility issue with the sphinx_rtd_theme (see the issue readthedocs/sphinx_rtd_theme#1343).

Revert this commit once this compatibility issue is resolved.

Signed-off-by: Stephanos Ioannidis root@stephanos.io

Sphinx 5.2.0.post0 release has a known compatibility issue with the
`sphinx_rtd_theme` (see the issue readthedocs/sphinx_rtd_theme#1343).

Revert this commit once this compatibility issue is resolved.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
@stephanosio
Copy link
Member Author

As a future change, it would be good to require a particular version of the Sphinx, theme, and its friends in the requirements-doc.txt to prevent problems like this. There is no reason why we should be using the latest version.

@stephanosio stephanosio added area: Documentation Infrastructure Hotfix Fix for issues blocking development, i.e. CI issues, tests failing in CI, etc. labels Sep 25, 2022
@gmarull
Copy link
Member

gmarull commented Sep 25, 2022

As a future change, it would be good to require a particular version of the Sphinx, theme, and its friends in the requirements-doc.txt to prevent problems like this. There is no reason why we should be using the latest version.

If we do this, we need to finally enforce usage of virtual environments, other softwares may require other versions. Still, it’s not a great practice because we do not control what subdependencies need, so best is to be flexible and potentially use lock files. We in fact use the ~= version specifier meaning “compatible”, ie 5.x. It seems that Sphinx is not following the rule (or they’ve made a mistake).

@carlescufi carlescufi merged commit f503847 into zephyrproject-rtos:main Sep 25, 2022
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants