micro-ROS / micro-ROS/micro_ros_setup

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

未关闭
#739 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Shell
星标
509
派生
183
平均合并
22 小时 26 分钟
30 天内合并 PR
7

描述

## 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:
```bash
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**:

```bash
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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

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.

由索引模型根据 Issue 内容生成。

评估

技术栈
python, shell
领域
build-system, tooling
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
描述清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。