louis_lifu
/
rclpy
mirror of https://github.com/ros2/rclpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
994 Commits 59 Branches 141 Tags 10 MiB
Python 73%
C++ 26.4%
CMake 0.5%
Go to file
Chris Lalancette 3e795547d4 10.0.0 2025-07-01 15:43:10 +00:00
rclpy 10.0.0 2025-07-01 15:43:10 +00:00
.gitignore refactor to allow for non-global init (#249) 2018-11-29 21:33:10 -08:00
CONTRIBUTING.md add section about DCO to CONTRIBUTING.md 2019-03-20 08:38:14 -07:00
LICENSE Initial implementation 2016-02-16 21:34:19 -08:00
README.md Fix readme deprecated link (#1411) 2025-02-05 14:35:35 -08:00
pytest.ini Add pytest.ini so tests succeed without warnings when run locally. (#587) 2020-06-25 12:45:53 -04:00

README.md

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.

Install dependencies

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

Build

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