micro-ROS / micro-ROS/micro_ros_setup

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

Ouverte
#739 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Shell
Étoiles
509
Forks
183
Merge moyen
22 h 26 min
PR mergées (30 j)
7

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par src/micro_ros_setup/config/zephyr/generic/create.sh vers la ligne 70 et examinez l’installation des dépendances utilisée par create_firmware_ws.sh zephyr. Reproduisez le problème avec ros2 run micro_ros_setup create_firmware_ws.sh zephyr dans le conteneur Docker Humble ou sur Ubuntu 22.04. Le travail est terminé lorsque le workspace firmware est créé sans le conflit entre docutils et sphinx-rtd-theme.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python, shell
Domaine
build-system, tooling
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.