rosdoc2 missing?

[vermaete]

Is there a reason why rosdoc2 is not in the meta layer?
https://github.com/ros-infrastructure/rosdoc2

[robwoolley]

The recipes get generated by superflore based on the YAML files in https://github.com/ros/rosdistro

The website index.ros.org uses the same data so it isn't there either.

The colcon tool is in a similar position.

We can certainly add a recipe for it and update it ourselves. I am not familiar with the tool. I would ask for a use case where it was needed either at runtime on the target or as a -native package as part of the build.

Cheers,
Rob

[vermaete]

@robwoolley
Thanks for the answer. I will take it up. I needed to generated the interface documentation with Sphinx.
There will be some dependencies missing too. But it could not be that hard.

[vermaete]

two missing RDEPENDS recipes are sent to openembedded-core:
python3-exhale:
https://patchwork.yoctoproject.org/project/oe-core/patch/20250330130052.2664988-1-jan.vermaete@gmail.com/
python3-breathe:
https://patchwork.yoctoproject.org/project/oe-core/patch/20250330101938.2634400-1-jan.vermaete@gmail.com/

[vermaete]

status update: all dependencies for rosdoc2 are not in meta-openembedded @ master

[robwoolley]

Nice!

https://layers.openembedded.org/layerindex/recipe/445433/
https://layers.openembedded.org/layerindex/recipe/445434/

[vermaete-oip]

And those (the latest commits):
openembedded/meta-openembedded@cb29690
openembedded/meta-openembedded@77adefe
openembedded/meta-openembedded@9d61671
openembedded/meta-openembedded@68bbadf

[vermaete]

just an update:

Some dependencies are missing in the tree of rosdoc2 -> sphinx -> ....
E.g. python3-markdown-it-py, python3-mdit-py-plugins, python3-beautifulsoup4
But all exist in meta-opemembedded :-)
And should be fixed in meta-openembedded

The older sphinx package in meta-ros should be removed and the one of meta-openembedded should be used.

python3-rosdoc2 will look like this (still WIP):

SUMMARY = "Command-line tool for generating documentation for ROS 2 packages."
LICENSE = "Apache-2.0"
LIC_FILES_CHKSUM = "file://PKG-INFO;beginline=10;endline=10;md5=d36ab912b8b544b7412f2d84c52072f1"

SRC_URI[sha256sum] = "fbb2ba4d0d867590955963363bf24b969c6ed18c24d730845b38884736b8ccf7"

inherit pypi python_setuptools_build_meta
inherit ros_distro_${ROS_DISTRO}

PYPI_PACKAGE = "rosdoc2"

RDEPENDS:${PN} = "\
    doxygen \
    graphviz \
    osrf-pycommon \
    python3-beautifulsoup4 \
    python3-breathe \
    python3-exhale \
    python3-jinja2 \
    python3-markdown-it-py \
    python3-mdit-py-plugins \
    python3-myst-parser \
    python3-pyyaml \
    python3-sphinx \
    python3-sphinx-rtd-theme \
    "

BBCLASSEXTEND = "native"

The only recipe is was testing is sensor-msgs

diff --git a/meta-ros2-rolling/recipes-bbappends/common-interfaces/sensor-msgs_5.7.0-1.bbappend b/meta-ros2-rolling/recipes-bbappends/common-interfaces/sensor-msgs_5.7.0-1.bbappend
index 8d88feaca..ef1832a9d 100644
--- a/meta-ros2-rolling/recipes-bbappends/common-interfaces/sensor-msgs_5.7.0-1.bbappend
+++ b/meta-ros2-rolling/recipes-bbappends/common-interfaces/sensor-msgs_5.7.0-1.bbappend
@@ -17,3 +17,17 @@ ROS_BUILD_DEPENDS += " \
     rosidl-typesupport-cpp \
     service-msgs \
 "
+
+# doc
+ROS_BUILD_DEPENDS += " \
+    python3-rosdoc2-native \
+"
+
+do_compile:append() {
+    rosdoc2 build --package-path ${S}
+}
+
+do_install:append() {
+    install -d ${D}${docdir}
+    cp -R ${B}/docs_output/${ROS_BPN} ${D}${docdir}
+}

more info: https://github.com/vermaete/meta-ros/tree/vermaete/rosdoc2

[vermaete]

Thanks for merging.
Next is using it to build the documentation as they do with rosdistro.