search

ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Support only messages #78

Closed rkent closed 3 months ago

rkent commented 3 months ago

This was less complex than I feared. Test case only_messages shows how this works.

I find the whole process of deciding what to run to be hard to understand. Here I change the decision to run breathe based on the existence of the doxygen output, while previously it was done based on build type. Both seem a little too much like black magic to me. I feel like it could use a refactoring, but maybe the complexity is just inherent and hard to improve.

Fixes #54

tfoote commented 3 months ago

Confirmed building on the bulidfarm with message only packages: https://docs.ros.org/en/rolling/p/trajectory_msgs/

https://build.ros2.org/view/Rdoc/job/Rdoc__common_interfaces__ubuntu_noble_amd64/2/console

Yadunund commented 3 months ago

🎉 🎉 🎉

ros-discourse commented 3 months ago

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/rosdoc2-undergoing-significant-change/36905/2

ros-discourse commented 1 month ago

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/plans-for-ros-2-documentation-particularly-api-docs/28638/23