rclpy icon indicating copy to clipboard operation
rclpy copied to clipboard

Fix doc generation for Humble

Open scotgopal opened this issue 9 months ago • 1 comments

Resolves #1412

Fixes doc generation for Humble

backports of #1109 and #1103

scotgopal avatar Feb 15 '25 19:02 scotgopal

Pulls: ros2/rclpy#1414 Gist: https://gist.githubusercontent.com/ahcorde/2b89f4c01b820d011930a55663b9388d/raw/7efb47d940d62f17ddecff8f93919c70b14780b9/ros2.repos BUILD args: --packages-up-to rclpy --packages-above-and-dependencies rclpy TEST args: --packages-select rclpy --packages-above rclpy ROS Distro: humble Job: ci_launcher ci_launcher ran: https://ci.ros2.org/job/ci_launcher/15205

  • Linux Build Status
  • Linux-aarch64 Build Status
  • Linux-rhel Build Status
  • Windows Build Status

ahcorde avatar Feb 17 '25 09:02 ahcorde

I haven't tried building the doc locally but we might need to also add dependencies that were introduced in #1408? Else we might run into #1160 (comment)

In the current state of the package.xml, there isn't seem to be an issue to generate docs for Node and Timer, @Yadunund . (hope my local renders are the same as yours, I'm on PyPI's rosdoc2==0.2.1)

Node

image

Timer

image

Hence, I don't think we need to address the backporting of #1408 in this MR. Unless, it may help with the following observation.

Keeping Rolling's hosted docs as reference, I noticed that the following 'code structure' section was missing from the locally generated docs for Humble.

image

Maybe this is what @fujitatomoya was mentioning in his comment. Despite them missing from view, when searching for a module, e.g., wait_for_message, we are able to get results. The doc build logs seems to indicate this too.

image

I have also tried rebuilding rclpy with #1408 implemented locally, still there was no improvement. I'm not sure if this can be solved with a rosdoc2 configuration or we rather need some new .rst. Do share your views.

scotgopal avatar Feb 19 '25 18:02 scotgopal