Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OpaqueFunction to list at docs.ros.org #826

Open
EmmanuelMess opened this issue Feb 7, 2025 · 3 comments
Open

Add OpaqueFunction to list at docs.ros.org #826

EmmanuelMess opened this issue Feb 7, 2025 · 3 comments
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@EmmanuelMess
Copy link

Searching for OpaqueFunction in docs.ros.org/en/rolling/p/launch I find nothing, it should be added: https://docs.ros.org/en/rolling/p/launch/search.html?q=OpaqueFunction&check_keywords=yes&area=default

@audrow audrow added the bug Something isn't working label Feb 20, 2025
@christophebedard
Copy link
Member

christophebedard commented Feb 20, 2025

I think this might be another case of the documentation generation (rosdoc2) breaking for some reason.

A search of "OpaqueFunction" doesn't return anything because the class itself isn't included in the docs. However, the module itself (opaque_function) is included. It should include the OpaqueFunction class, but it doesn't: https://docs.ros.org/en/rolling/p/launch/launch.actions.opaque_function.html.

For example, this page for the launch_ros.actions.node module doesn't show anything in the Humble docs: https://docs.ros.org/en/humble/p/launch_ros/launch_ros.actions.node.html. It was fixed in ros2/launch_ros#425, so in Rolling the docs for that module look much better: https://docs.ros.org/en/rolling/p/launch_ros/launch_ros.actions.node.html.

If I run rosdoc2 on launch (@ Rolling) locally, I get this:

Image

Not sure why it's not showing up on https://docs.ros.org/en/rolling/p/launch/launch.actions.opaque_function.html. Any help would be appreciated.

@christophebedard christophebedard added the help wanted Extra attention is needed label Feb 20, 2025
@christophebedard christophebedard removed their assignment Feb 20, 2025
@EmmanuelMess
Copy link
Author

Not sure why it's not showing up on docs.ros.org/en/rolling/p/launch/launch.actions.opaque_function.html. Any help would be appreciated.

If you add a link to your last CI execution, I can try to find a fix.

@christophebedard
Copy link
Member

You can find all documentation jobs for Rolling here: https://build.ros2.org/view/Rdoc/. For example, the job for this repo is: https://build.ros2.org/view/Rdoc/job/Rdoc__launch__ubuntu_noble_amd64/. Then you can click on the last build, and Console Output + Full Log. This is the last one: https://build.ros2.org/view/Rdoc/job/Rdoc__launch__ubuntu_noble_amd64/28/consoleFull

Similarly, for Jazzy, the last job would be: https://build.ros2.org/view/Jdoc/job/Jdoc__launch__ubuntu_noble_amd64/6/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants