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

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.

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.