用語集

builder

A class (inheriting from Builder) that takes parsed documents and performs an action on them. Normally, builders translate the documents to an output format, but it is also possible to use the builder builders that e.g. check for broken links in the documentation, or build coverage information.

See Available builders for an overview over Sphinx’ built-in builders.

description unit

The basic building block of Sphinx documentation. Every “description directive” (e.g. function or describe) creates such a unit; and most units can be cross-referenced to.

環境

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

ソースディレクトリ

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

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

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