Skip to content

Commit

Permalink
Make Package Docs Even More Obvious (ros2#4296)
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 <katherineAScott@gmail.com>
Co-authored-by: Chris Lalancette <clalancette@gmail.com>
  • Loading branch information
kscottz and clalancette committed Apr 18, 2024
1 parent 3f6ddb9 commit 17aae9c
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 19 deletions.
18 changes: 0 additions & 18 deletions source/API-Docs.rst

This file was deleted.

37 changes: 37 additions & 0 deletions source/Package-Docs.rst
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`.
5 changes: 4 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,20 @@ ROS 2 Documentation
Concepts
Contact
The-ROS2-Project
API-Docs
Package-Docs
Related-Projects
Glossary
Citations


**The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications.**
From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project.

Since ROS was started in 2007, a lot has changed in the robotics and ROS community.
The goal of the ROS 2 project is to adapt to these changes, leveraging what is great about ROS 1 and improving what isn’t.

**Are you looking for documentation for a particular ROS package like MoveIt, image_proc, or octomap?** Please see `ROS Index <https://index.ros.org/packages/#{DISTRO}>`__ or check out `this index of per-package documentation <https://docs.ros.org/en/{DISTRO}/p/>`__.

This site contains the documentation for ROS 2.
If you are looking for ROS 1 documentation, check out the `ROS wiki <https://wiki.ros.org>`__.

Expand Down

0 comments on commit 17aae9c

Please sign in to comment.