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 msgs, services, and actions #76

Closed rkent closed 3 months ago

rkent commented 3 months ago

This will show messages, services, and actions (with just their raw text) in packages that already have C++ content. Unfortunately it does not resolve issue #54, that will take additional effort.

In the test cases, full_package has messages, services, and actions that can show how this works.

The majority of real packages that have msg definitions seem to be in msg-only packages, which will still fail. So this PR does not really solve the real-world problem yet, but I will submit a PR to address msg-only packages. It does not really matter to me if this is reviewed and landed first, or if you wait until I resolve the case of message-only packages, it is the same amount of work for me. Your choice.

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