ros2/ros2_documentation

ROS 2 docs repository

해결하는 문제

이 저장소는 공식 ROS 2 문서의 중앙 소스 역할을 합니다. docs.ros.org에 호스팅된 문서 웹사이트를 생성하는 데 필요한 파일과 빌드 지침을 제공합니다.

작동 방식

이 프로젝트는 Sphinx를 사용하여 소스 파일을 탐색 가능한 HTML 웹사이트로 변환합니다. 변경 사항을 즉시 확인할 수 있는 라이브 리로드, 자동 맞춤법 검사, 그리고 다양한 ROS 2 릴리스에 맞춰 여러 버전의 문서를 빌드하는 기능 등 로컬 개발을 위한 도구가 포함되어 있습니다.

대상 사용자

이 저장소는 공식 ROS 2 문서를 라이브 사이트에 게시하기 전에 개선, 업데이트 또는 테스트하려는 기여자 및 유지 관리자를 위한 것입니다.

주요 특징

  • 빠른 문서 반복을 위한 라이브 리로드 지원.
  • 사용자 지정 화이트리스트 및 사전 지원을 포함한 자동 맞춤법 검사.
  • 다중 버전 문서 구조의 로컬 테스트 가능.
  • 병렬 빌드에 최적화되어 처리 시간 단축.
  • Python 가상 환경을 사용하여 재현 가능한 개발 환경을 설정하는 명확한 지침 제공.

관련

  • 프로젝트
  • 프로젝트
  • 프로젝트
  • 프로젝트