ros2/ros2_documentation

ROS 2 docs repository

What it solves

This repository serves as the central source for the official ROS 2 documentation. It provides the files and build instructions necessary to generate the documentation website hosted at docs.ros.org.

How it works

The project uses Sphinx to convert source files into a browsable HTML website. It includes tools for local development, such as live-reloading to see changes instantly, automated spelling checks, and the ability to build multiple versions of the documentation to match different ROS 2 releases.

Who it’s for

This repository is for contributors and maintainers who want to improve, update, or test the official ROS 2 documentation before it is published to the live site.

Highlights

  • Supports live-reloading for rapid documentation iteration.
  • Includes automated spelling checks with custom whitelist and dictionary support.
  • Enables local testing of the multi-version documentation structure.
  • Optimized for parallel builds to speed up processing time.
  • Provides clear instructions for setting up reproducible development environments using Python virtual environments.

Related

  • Project
    ros-controls/ros2_control

    A framework for controlling robots within the ROS 2 ecosystem, providing a standardized way to manage robot hardware and control loops.

  • Project
    MOLAorg/mola

    MOLA is an open‑source C++/ROS 2 framework for LiDAR‑based odometry, LiDAR‑Inertial odometry and metric‑map creation. It offers YAML‑driven, plug‑in pipelines, supports GNSS‑LiDAR‑IMU fusion for sub‑centimetre mapping, and provides a rich `.mm` map ecosystem. Built for multiple ROS 2 distributions, it targets autonomous robots needing accurate, configurable localization and mapping.

  • Project
    Chestnut-Robotics/aero-hand-open

    An open-source, 3D-printed tendon-driven robotic hand designed for affordable dexterous manipulation research and reinforcement learning.

  • Project
    Roboparty/RP1

    RP1 is an open-source full-stack platform for building and controlling humanoid robots, covering everything from mechanical design and electronics to firmware, control, and AI learning. It gives developers the complete stack to reproduce, understand, and extend a human-sized humanoid.