Skip to content

Commit

Permalink
Update source/How-To-Guides/Documenting-a-ROS-2-Package.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: Jonas Otto <[email protected]>
  • Loading branch information
ottojo and clalancette authored Mar 19, 2024
1 parent 78f45e8 commit 6b21e60
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion source/How-To-Guides/Documenting-a-ROS-2-Package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Package Documentation Overview
------------------------------

The type of documentation discussed in this guide is referred to as "package docs" or "API docs".
For ROS packages that have been released on ROS Index, their documentation will be built on the ROS buildfarm, included on docs.ros.org, and visible on via the ``API Docs`` button on index.ros.org.
For ROS packages that have been released on ROS Index, their documentation will be built on the ROS buildfarm, included on docs.ros.org, and visible via the ``API Docs`` button on index.ros.org.

The tool responsible for generating ROS 2 package docs is `rosdoc2 <https://github.com/ros-infrastructure/rosdoc2>`__.

Expand Down

0 comments on commit 6b21e60

Please sign in to comment.