Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
#739 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
python, shell

Research direction

Start with src/micro_ros_setup/config/zephyr/generic/create.sh around line 70 and review the dependency installation used by create_firmware_ws.sh zephyr. Reproduce with ros2 run micro_ros_setup create_firmware_ws.sh zephyr in the Humble Docker container or Ubuntu 22.04. Done means the firmware workspace is created without the docutils and sphinx-rtd-theme conflict.

Written by the indexing model from the issue text.

Description

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

  • Hardware description: N/A (not hardware specific)

  • RTOS: Zephyr

  • Installation type: micro_ros_setup

  • Version or commit hash: a146e83

  • Python version: Python 3.10.12

  • OS: Ubuntu 22.04.5 LTS

Steps to reproduce the issue
  1. Follow the micro-ROS Zephyr setup instructions.
  2. Run the following command to create a firmware workspace:
    ros2 run micro_ros_setup create_firmware_ws.sh zephyr
    
  3. The script fails with a docutils version conflict.
Expected behavior

The firmware workspace should be created without any dependency conflicts.

Actual behavior

The script fails with the following error due to an incompatibility between sphinx-rtd-theme and the installed version of docutils:

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.
Additional information

I was able to resolve the issue by modifying the create.sh file in src/micro_ros_setup/config/zephyr/generic/ at line 70:

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

This forces the installation of a compatible version of docutils and prevents pip from installing docutils 0.17.1. To fix the issue permanently, I suggest adding this change to the official create.sh script to ensure compatibility with sphinx-rtd-theme 0.5.2.

I tested this issue both in my local environment (Ubuntu 22.04.5 LTS) and in the official Humble Docker container. The issue was reproducible in both setups.

The full logs are available if needed, but they are quite lengthy.

Dominant language
Shell
Stars
509
Forks
183
Avg merge
22h 26m
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from micro-ROS/micro_ros_setup

All issues in micro-ROS/micro_ros_setup

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.