用語集

ビルダー

Builder を継承したクラスで、パースされたドキュメントを受け取り、それに対してアクションをします。通常、ビルダーは他の出力フォーマットへ、ドキュメントを変換しますが、壊れたリンクのチェックを行ったり、情報のカバレッジを計測したり、といった用途にも使用することができます。

Sphinxの内蔵のビルダーに関しては、 利用可能なビルダー のドキュメントを参照してください。

説明ユニット

Sphinxドキュメントを構築する、基本構成単位です。すべての “説明用ディレクティブ”(function, describe)はこのユニットを作成します。ほとんどのユニットに対して、クロスリファレンスを行うことができます。

環境

ルート以下のすべてのドキュメントの情報が格納される場所です。この情報はクロスリファレンスを作成する際に利用されます。この環境には、パース段階の後の結果のpickleされたものが入ります。ソースファイルが新規で作成されたり、変更されて、読み込んだりパースしたりする必要がない限りはこの中のデータが更新されることはありません。

ソースディレクトリ

ひとつのSphinxプロジェクトにおいて、すべてのソースファイルを含むディレクトリ。このディレクトリ直下だけではなく、サブディレクトリを使用してソースファイルを分類して入れておくことも可能です。

コンフィグレーションディレクトリ

conf.py を含むディレクトリ。デフォルトでは ソースディレクトリ と同じですが、 -c コマンドラインオプションを使用することで変更することができます。