micro-ROS / micro-ROS/micro_ros_setup

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

Đang mở
#739 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Shell
Star
509
Fork
183
Merge trung bình
22 giờ 26 phút
Pull request đã merge (30 ngày)
7

Mô tả

## 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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python, shell
Lĩnh vực
build-system, tooling
Loại issue
Lỗi
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.