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

Sphinx dependency conflict fix #740

Merged
merged 1 commit into from
Oct 16, 2024
Merged

Conversation

Geibinger
Copy link

Description:
This pull request fixes the docutils version conflict encountered when setting up a micro-ROS workspace with Zephyr, as reported in issue #739.

Problem:

The issue arises because sphinx-rtd-theme (version 0.5.2) requires docutils<0.17, but during the setup process, docutils 0.17.1 is installed, causing the following error:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
sphinx-rtd-theme 0.5.2 requires docutils<0.17, but you have docutils 0.17.1 which is incompatible.

Solution:

To resolve this, I modified the create.sh script located at config/zephyr/generic/ by pinning the docutils version to 0.16, which is compatible with sphinx-rtd-theme. The change is at line 70 of the script:

pip install --force-reinstall docutils==0.16 Sphinx==4.2.0

Testing:

The solution was tested in both my local environment (Ubuntu 22.04.5 LTS) and in the official Humble Docker container. The issue was reproducible in both environments, and the fix successfully resolved the version conflict in both cases.

Related Issue:

This PR fixes issue #739.

@Geibinger Geibinger requested a review from pablogs9 as a code owner October 15, 2024 14:46
@pablogs9
Copy link
Member

@mergify backport jazzy iron rolling

Copy link
Contributor

mergify bot commented Oct 16, 2024

backport jazzy iron rolling

✅ Backports have been created

@pablogs9 pablogs9 merged commit 96ab3c1 into micro-ROS:humble Oct 16, 2024
21 checks passed
mergify bot pushed a commit that referenced this pull request Oct 16, 2024
Signed-off-by: Geibinger <[email protected]>
(cherry picked from commit 96ab3c1)

# Conflicts:
#	config/zephyr/generic/create.sh
mergify bot pushed a commit that referenced this pull request Oct 16, 2024
Signed-off-by: Geibinger <[email protected]>
(cherry picked from commit 96ab3c1)
mergify bot pushed a commit that referenced this pull request Oct 16, 2024
Signed-off-by: Geibinger <[email protected]>
(cherry picked from commit 96ab3c1)
pablogs9 added a commit that referenced this pull request Oct 16, 2024
Signed-off-by: Geibinger <[email protected]>
(cherry picked from commit 96ab3c1)

Co-authored-by: Jakob Friedl <[email protected]>
pablogs9 added a commit that referenced this pull request Oct 16, 2024
Signed-off-by: Geibinger <[email protected]>
(cherry picked from commit 96ab3c1)

Co-authored-by: Jakob Friedl <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants