ros2/ros2_documentation
ROS 2 docs repository
解決する課題
このリポジトリは、公式の ROS 2 ドキュメントの中心的なソースとして機能します。docs.ros.org でホストされているドキュメントサイトを生成するために必要なファイルとビルド手順を提供します。
仕組み
このプロジェクトは Sphinx を使用して、ソースファイルを閲覧可能な HTML サイトに変換します。変更を即座に確認できるライブリロード、自動スペルチェック、異なる ROS 2 リリースに合わせてドキュメントの複数バージョンをビルドする機能など、ローカル開発用のツールが含まれています。
対象読者
このリポジトリは、公式の ROS 2 ドキュメントを公開前に改善、更新、またはテストしたい貢献者やメンテナー向けです。
ハイライト
- 迅速なドキュメント反復のためのライブリロードをサポート。
- カスタムホワイトリストと辞書サポートを備えた自動スペルチェックを含みます。
- マルチバージョン・ドキュメント構造のローカルテストを可能にします。
- 並列ビルドに最適化されており、処理時間を短縮します。
- Python 仮想環境を使用して再現可能な開発環境をセットアップするための明確な手順を提供します。
関連
- プロジェクト
- プロジェクト
- プロジェクト
- プロジェクト