Skip to content
forked from ros2/rclpy

rclpy (ROS Client Library for Python)

License

Notifications You must be signed in to change notification settings

leeminju531/rclpy

This branch is 1 commit behind ros2/rclpy:rolling.

Repository files navigation

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

About

rclpy (ROS Client Library for Python)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 75.5%
  • C++ 23.8%
  • Other 0.7%