ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question
0

How to get to the correct documentation page?

asked 2020-10-07 01:38:09 -0500

Rufus gravatar image

updated 2020-10-07 01:42:51 -0500

Suppose I'm trying to look up the documentation for geometry_msgs.

  1. I start from https://docs.ros.org/melodic/api/ (which I perceive to be the root of the ros documentation)
  2. Find the geometry_msgs folder (https://docs.ros.org/melodic/api/geometry_msgs/)
  3. Open the html folder (https://docs.ros.org/melodic/api/geometry_msgs/html/)

However, that is just a dummy page. The correct page I'm expecting is actually http://docs.ros.org/melodic/api/geometry_msgs/html/index-msg.html

I couldn't quite figure out a way to get to that page from the documentation root and the only way of getting to the correct page is by googling. It seems rather unintuitive that the correct documentation pages can only be found by google and not by navigating through the documentation itself. This also makes finding less commonly linked documentation (which may not appear in google searches) more difficult.

edit retag flag offensive close merge delete

1 Answer

Sort by » oldest newest most voted
2

answered 2020-10-07 04:38:48 -0500

gvdhoorn gravatar image

updated 2020-10-07 04:39:46 -0500

You'd go to wiki/geometry_msgs and click on Msg API in the Package Links box in top right of the page.

That takes you directly to docs.ros.org/noetic/api/geometry_msgs/html/index-msg.html.

I start from https://docs.ros.org/melodic/api/ (which I perceive to be the root of the ros documentation)

Personally I would consider the ROS wiki to be "the root of the ros documentation" for ROS 1.

For ROS 2, it would be the ROS Index.

edit flag offensive delete link more

Comments

Thanks for the answer. Somewhat unrelated, but is there a reason why the Code API pages don't have a search bar?

Rufus gravatar image Rufus  ( 2020-10-13 03:33:20 -0500 )edit

I wouldn't know.

Probably because it has not been enabled in the Doxygen config file template used by the doc generation infrastructure.

Perhaps if you open a PR this could be changed.

gvdhoorn gravatar image gvdhoorn  ( 2020-10-13 03:39:45 -0500 )edit

Question Tools

1 follower

Stats

Asked: 2020-10-07 01:38:09 -0500

Seen: 96 times

Last updated: Oct 07 '20