Repolode
제출하기
breathe-doc

breathe-doc/breathe

Doxygen으로 생성한 C/C++ API 문서를 reStructuredText 및 Sphinx 문서에 통합하는 Sphinx 플러그인입니다.

GitHub에서 보기웹사이트
스타
816
포크
215
열린 이슈
220
마지막 커밋
6일 전

어떤 프로젝트인가요?

Breathe는 Doxygen과 Sphinx를 연결합니다. Doxygen은 소스 코드를 분석해 클래스, 함수 및 기타 심볼의 상세 모델을 추출하고, Sphinx는 완성도 높은 장문 문서를 생성합니다. Breathe는 Doxygen의 XML 출력을 읽어 Sphinx 디렉티브로 제공하므로, 같은 문서 세트에서 직접 작성한 설명과 함께 API 레퍼런스 페이지를 작성하고 스타일을 지정할 수 있습니다.

이 플러그인은 pip으로 PyPI에서 설치할 수 있으며 Python 3.9+, Sphinx 7.2+, Doxygen 1.9.2+가 필요합니다. 문서에는 사용 가능한 디렉티브를 다루는 예제가 포함되어 있고, 저장소에는 테스트 스위트와 커밋 간 문서 출력 차이를 확인하는 비교 스크립트가 있습니다.

이 프로젝트는 소규모 기여자 그룹이 유지 관리하고 있으며, PyTorch, NumPy, Apache Arrow를 비롯한 여러 대형 오픈소스 코드베이스에서 C 및 C++ API 레퍼런스를 게시하는 데 사용됩니다.

핵심 기능

  • 01Doxygen XML 출력을 C, C++ 및 관련 심볼을 위한 Sphinx 디렉티브로 렌더링합니다.
  • 02직접 작성한 reStructuredText 콘텐츠와 나란히 API 레퍼런스 페이지를 구성할 수 있습니다.
  • 03pip으로 PyPI에서 설치할 수 있습니다.
  • 04Python 3.9+, Sphinx 7.2+, Doxygen 1.9.2+가 필요합니다.
  • 05테스트 스위트와 커밋 간 문서 출력 비교 스크립트가 포함되어 있습니다.

활용 사례

  • Sphinx에서 C 또는 C++ 라이브러리의 API 레퍼런스를 사용자 가이드와 함께 게시합니다.
  • 소스 코드 주석에서 생성한 API 문서를 직접 작성한 문서와 동기화합니다.
  • 이미 Doxygen을 사용하는 임베디드 또는 시스템 코드베이스를 문서화합니다.

빠른 시작

  1. 1

    PyPI에서 Breathe 설치

    pip install breathe

사용 전 알아둘 점

  • Doxygen 1.9.2 이상과 Sphinx 7.2 이상을 별도로 설치해야 합니다.
  • 메타데이터에 라이선스가 명확하게 지정되어 있지 않습니다.

포함된 컬렉션

정적 사이트 생성기 및 문서 도구

토픽

#sphinx#doxygen#documentation#c-plus-plus#api-reference#python

자주 묻는 질문

breathe은(는) 무엇인가요?
Doxygen으로 생성한 C/C++ API 문서를 reStructuredText 및 Sphinx 문서에 통합하는 Sphinx 플러그인입니다. Breathe는 Doxygen과 Sphinx를 연결합니다. Doxygen은 소스 코드를 분석해 클래스, 함수 및 기타 심볼의 상세 모델을 추출하고, Sphinx는 완성도 높은 장문 문서를 생성합니다. Breathe는 Doxygen의 XML 출력을 읽어 Sphinx 디렉티브로 제공하므로, 같은 문서 세트에서 직접 작성한 설명과 함께 API 레퍼런스 페이지를 작성하고 스타일을 지정할 수 있습니다.
breathe은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
breathe은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
breathe은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. breathe의 마지막 커밋은 2026년 11월 1일입니다.
breathe은(는) 어디에 사용할 수 있나요?
Sphinx에서 C 또는 C++ 라이브러리의 API 레퍼런스를 사용자 가이드와 함께 게시합니다. 소스 코드 주석에서 생성한 API 문서를 직접 작성한 문서와 동기화합니다. 이미 Doxygen을 사용하는 임베디드 또는 시스템 코드베이스를 문서화합니다.
breathe는 어떻게 설치하나요?
PyPI에서 Breathe 설치: pip install breathe
breathe은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/breathe-doc/breathe

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트