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 (backport #740) #741

Closed
wants to merge 1 commit into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 16, 2024

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.


This is an automatic backport of pull request #740 done by Mergify.

Signed-off-by: Geibinger <friedl.jak@gmail.com>
(cherry picked from commit 96ab3c1)

# Conflicts:
#	config/zephyr/generic/create.sh
Copy link
Contributor Author

mergify bot commented Oct 16, 2024

Cherry-pick of 96ab3c1 has failed:

On branch mergify/bp/jazzy/pr-740
Your branch is up to date with 'origin/jazzy'.

You are currently cherry-picking commit 96ab3c1.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   NOTICE

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   config/zephyr/generic/create.sh

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot requested a review from pablogs9 as a code owner October 16, 2024 06:35
@mergify mergify bot added the conflicts label Oct 16, 2024
@mergify mergify bot mentioned this pull request Oct 16, 2024
@pablogs9 pablogs9 closed this Oct 16, 2024
@pablogs9 pablogs9 deleted the mergify/bp/jazzy/pr-740 branch October 16, 2024 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dependency Conflict in micro-ROS Zephyr Setup Due to docutils Version Incompatibility
2 participants