rclpy

ROS Client Library for the Python language.

Building documentation

Documentation can be built for rclpy using Sphinx, or accessed online

For building documentation, you need an installation of ROS 2.

sudo apt install \
  python3-sphinx \
  python3-sphinx-autodoc-typehints \
  python3-sphinx-rtd-theme

Source your ROS 2 installation, for example:

. /opt/ros/rolling/setup.bash

Build code:

mkdir -p rclpy_ws/src
cd rclpy_ws/src
git clone https://github.com/ros2/rclpy.git
cd ..
colcon build --symlink-install

Source workspace and build docs:

source install/setup.bash
cd src/rclpy/rclpy/docs
make html