-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Updated existing page based on CL input. * Add new file. Signed-off-by: Katherine Scott <[email protected]> Co-authored-by: Chris Lalancette <[email protected]> (cherry picked from commit 17aae9c) Co-authored-by: Katherine Scott <[email protected]>
- Loading branch information
1 parent
5e9610c
commit 3ee534d
Showing
3 changed files
with
41 additions
and
19 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.. redirect-from:: | ||
|
||
Package Docs | ||
============ | ||
|
||
ROS package documentation, that is to say documentation for specific packages you install via apt or some other tool, can be found in multiple places. | ||
Here is a brief list of where to look for specific ROS package documentation. | ||
|
||
|
||
* Most ROS 2 packages have their package level documentation `included in this index page <https://docs.ros.org/en/{DISTRO}/p/>`__. | ||
* All ROS 2 package's documentation is hosted alongside its information on the `ROS Index <https://index.ros.org/>`_. Searching for packages on ROS Index will yield their information such as released distributions, ``README.md`` files, URLs, and other important metadata. | ||
|
||
Larger Packages | ||
--------------- | ||
|
||
Larger packages like MoveIt, Nav2, and microROS, are given their own subdomain on docs.ros.org. Here is a short list. | ||
|
||
* `MoveIt <https://moveit.ros.org/>`__ | ||
* `Navigation <https://navigation.ros.org/>`__ | ||
* `Control <https://control.ros.org/master/index.html>`__ | ||
* `microROS (embedded systems) <https://micro.ros.org/>`__ | ||
|
||
API Documentation | ||
----------------- | ||
|
||
You can find the API level documentation for the ROS client libraries in the {DISTRO_TITLE} distribution using the links below: | ||
|
||
* `rclcpp - C++ client library <http://docs.ros.org/en/{DISTRO}/p/rclcpp/generated/index.html>`_ | ||
* `rclcpp_lifecycle - C++ lifecycle library <http://docs.ros.org/en/{DISTRO}/p/rclcpp_lifecycle/generated/index.html>`_ | ||
* `rclcpp_components - C++ components library <http://docs.ros.org/en/{DISTRO}/p/rclcpp_components/generated/index.html>`_ | ||
* `rclcpp_action - C++ actions library <http://docs.ros.org/en/{DISTRO}/p/rclcpp_action/generated/index.html>`_ | ||
|
||
Adding Your Package to docs.ros.org | ||
----------------------------------- | ||
|
||
All released ROS 2 packages are automatically added to docs.ros.org and `ROS Index <https://index.ros.org/>`_. | ||
If you would like to enable or configure your own package please see: :doc:`./How-To-Guides/Documenting-a-ROS-2-Package`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters