search

ros2 / launch

Tools for launching multiple processes and for writing tests involving multiple processes.
Apache License 2.0
126 stars 144 forks source link

Enable document generation using rosdoc2 for ament_python pkgs #697

Closed Yadunund closed 1 year ago

Yadunund commented 1 year ago

Fix missing exec_depends in package.xmls and docstrings to generate documentation without most warnings using autodoc

Note: One one warning is pending. Can be addressed in a future PR

ws_rosdoc2/docs_build/launch/launch/event_handlers/event_named.py:docstring of launch.event_handlers.event_named:1: WARNING: duplicate object description of launch.event_handlers.event_named, other instance in launch.event_handlers, use :noindex: for one of them
clalancette commented 1 year ago

CI:

clalancette commented 1 year ago

@Yadunund it looks like Windows is not happy with this change. Could you take a look?

Yadunund commented 1 year ago

Looks like it was caused due to a limitation of python3.8 on Windows.

CI:

clalancette commented 1 year ago

Windows is still unhappy:

02:39:28.465 _____________________ ERROR collecting doc/source/conf.py _____________________
02:39:28.465 doc\source\conf.py:148: in <module>
02:39:28.465     latex_elements: dict[str, str] = {
02:39:28.466 E   TypeError: 'type' object is not subscriptable
02:39:28.466 ------------ generated xml file: C:\ci\ws\build\launch\pytest.xml -------------
02:39:28.466 =========================== short test summary info ===========================
02:39:28.466 ERROR doc/source/conf.py - TypeError: 'type' object is not subscriptable
02:39:28.466 !!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
02:39:28.466 ========================= 1 warning, 1 error in 1.80s =========================
Yadunund commented 1 year ago

CI:

clalancette commented 1 year ago

The warnings on Windows are well-known flakes, so going ahead and merging this.