breathe-doc/breathe

これは何？

主な機能

• 01DoxygenのXML出力を、C、C++および関連するシンボル用のSphinxディレクティブとしてレンダリングします。
• 02APIリファレンスのページを、手書きのreStructuredTextコンテンツと並べて配置できます。
• 03pipを使ってPyPIからインストールできます。
• 04Python 3.9以降、Sphinx 7.2以降、Doxygen 1.9.2以降が必要です。
• 05テストスイートと、コミット間のドキュメント出力を比較するスクリプトが含まれています。

ユースケース

• CまたはC++ライブラリのAPIリファレンスを、Sphinxでユーザーガイドと一緒に公開する。
• ソースコードのコメントから生成したAPIドキュメントを、手書きのドキュメントと同期させる。
• すでにDoxygenを使っている組み込み系またはシステム系のコードベースをドキュメント化する。

クイックスタート

1. 1

   PyPIからBreatheをインストール

   pip install breathe

使う前に知っておきたいこと

• !Doxygen 1.9.2以降とSphinx 7.2以降を別途インストールする必要があります。
• !メタデータにライセンスが明確に記載されていません。

収録されている特集

トピック

よくある質問

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 は何に使えますか？

CまたはC++ライブラリのAPIリファレンスを、Sphinxでユーザーガイドと一緒に公開する。 ソースコードのコメントから生成したAPIドキュメントを、手書きのドキュメントと同期させる。 すでにDoxygenを使っている組み込み系またはシステム系のコードベースをドキュメント化する。

breathe のインストール方法は？

PyPIからBreatheをインストール: pip install breathe

breathe はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/breathe-doc/breathe