用語集¶

ビルダー¶

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

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

設定ディレクトリ¶

conf.py を含むディレクトリです。デフォルトでは、ソースディレクトリと同じですが、-c コマンドラインで別のディレクトリも設定できます。

ディレクティブ¶

reSturcturedTextのマークアップの要素で、特別な意味を持つコンテンツのブロックを表現できます。ディレクティブはDocutils由来のものだけでなく、Sphinx、カスタムの拡張機能によって定義されたものも使用できます。基本的なディレクティブの文法は次のようになります:

.. directive-name:: argument ...
   :option: value

   Content of the directive.

より詳しい情報はディレクティブを参照してください。

ドキュメント名¶

Since reStructuredText source files can have different extensions (some people like .txt, some like .rst -- the extension can be configured with source_suffix) and different OSes have different path separators, Sphinx abstracts them: document names are always relative to the source directory, the extension is stripped, and path separators are converted to slashes. All values, parameters and such referring to "documents" expect such document names.

ドキュメント名のサンプルとしては、 index, library/zipfile, reference/datamodel/types などがあります。前後のスラッシュは完全に省略されることに注意して下さい。

ドメイン¶

ドメインは、特定のプログラミング言語の要素などのオブジェクトの説明をしたり、リンクを張ったりするような、マークアップ(reSturucturedTextのディレクティブ, ロール)を集めたものです。ドメインに属するディレクティブとロールの名前は、 py:function のように ドメイン:名前 となります。

ドメインがあるということは、C++とPythonの両方のクラスに言及したいようなドキュメントを書く場合でも、名前が衝突する問題がない、ということです。まったく新しい言語のドキュメントをサポートするのも簡単になります。

For more information, refer to Domains.

環境¶

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

拡張¶

Sphinxのカスタム role 、 directive 、またはその他の側面で、Sphinx内のビルドプロセスの任意の側面を変更できます。

詳しくは、拡張を参照してください。

マスタードキュメント¶

root document¶

ルートとなる toctree ディレクティブを含むドキュメントです。

オブジェクト¶

The basic building block of Sphinx documentation. Every "object directive" (e.g. py:function or object) creates such a block; and most objects can be cross-referenced to.

RemoveInSphinxXXXWarning¶

SphinxのXXXバージョンでこの機能が削除される警告です。通常、Sphinx拡張で利用しているAPIが非推奨となった場合等に発生します。参考: Deprecation Warnings.

ロール¶

reStuructredTextのマークアップの要素で、テキスト片にマーキングを行えます。ディレクティブと同様に、ロールも拡張できます。基本的な文法は次のようになります: :ロール名:`コンテンツ` 。詳しくはインラインマークアップを参照してください。

ソースディレクトリ¶

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

reStructuredText¶

平文markup構文とparserシステムで、読みやすく、見たまま、見たまま、手に入れたままです。