https://github.com/ros2/rclpy

rclpy (ROS Client Library for Python)
https://github.com/ros2/rclpy

hacktoberfest

Last synced: 1 day ago
JSON representation

rclpy (ROS Client Library for Python)

• Host: GitHub
• URL: https://github.com/ros2/rclpy
• Owner: ros2
• License: apache-2.0
• Created: 2015-11-19T19:34:49.000Z (almost 9 years ago)
• Default Branch: rolling
• Last Pushed: 2024-09-13T20:00:54.000Z (2 months ago)
• Last Synced: 2024-09-14T10:53:45.418Z (2 months ago)
• Topics: hacktoberfest
• Language: Python
• Homepage:
• Size: 2.79 MB
• Stars: 285
• Watchers: 26
• Forks: 224
• Open Issues: 134
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# rclpy

ROS Client Library for the Python language.

## Building documentation

Documentation can be built for `rclpy` using [Sphinx](http://www.sphinx-doc.org/en/master/), or accessed [online](http://docs.ros2.org/latest/api/rclpy/index.html)

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