ros2/ros2_documentation

ROS 2 docs repository

解决的问题

此仓库是官方 ROS 2 文档的中心源。它提供了生成托管在 docs.ros.org 上的文档网站所需的文件和构建说明。

工作原理

该项目使用 Sphinx 将源文件转换为可浏览的 HTML 网站。它包含用于本地开发的工具,例如用于即时查看更改的实时重载、自动拼写检查,以及构建多个文档版本以匹配不同 ROS 2 版本的功能。

适用对象

此仓库适用于希望在发布到实时站点之前改进、更新或测试官方 ROS 2 文档的贡献者和维护者。

主要亮点

  • 支持实时重载,实现快速文档迭代。
  • 包含带有自定义白名单和字典支持的自动拼写检查。
  • 支持本地测试多版本文档结构。
  • 针对并行构建进行了优化,以加快处理时间。
  • 提供使用 Python 虚拟环境设置可复现开发环境的明确说明。

相关

  • 项目
  • 项目
  • 项目
  • 项目