search

ros-controls / control.ros.org

https://control.ros.org
Apache License 2.0
9 stars 35 forks source link

Add API page #268

Closed christophfroehlich closed 1 month ago

christophfroehlich commented 1 month ago

I'd like to include the API documentation of all packages, also for the utilities like control_toolbox etc.

I see two options:

  1. Make a table and just link to docs.ros.org like here. It will be a bit more visible than now, but not searchable from control.ros.org
  2. Let rosdoc2 create the pages manually and publish a selection on control.ros.org. Advantage (or maybe also disadvantage?): Everything can be found from within a single search prompt.

The majority was for option 1 during the WG meeting on April 10th. I changed it now to a simple table:

image

christophfroehlich commented 1 month ago

@mergifyio backport humble iron

mergify[bot] commented 1 month ago

backport humble iron

✅ Backports have been created

* [#269 Add API page (backport #268)](https://github.com/ros-controls/control.ros.org/pull/269) has been created for branch `humble` but encountered conflicts * [#270 Add API page (backport #268)](https://github.com/ros-controls/control.ros.org/pull/270) has been created for branch `iron` but encountered conflicts