用語集¶

ビルダー¶

(Builder を継承する)クラスで、解析済みのドキュメントを受け取り、それらに対して処理を実行します。通常、ビルダーはドキュメントを出力形式に変換しますが、ドキュメント内の壊れたリンクをチェックしたり、カバレッジ情報を構築したりするビルダーを使用することも可能です。

Sphinx の組み込みビルダーの概要については、ビルダーを参照してください。

設定ディレクトリ¶

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

ディレクティブ¶

コンテンツのブロックに特別な意味を付けることを許可する reStructuredText マークアップ要素です。ディレクティブは docutils によって提供されるだけでなく、Sphinx やカスタム拡張機能でも独自のディレクティブを追加できます。基本的なディレクティブ構文は次のようになります。

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

   Content of the directive.

詳細については、ディレクティブを参照してください。

ドキュメント名¶

reStructuredText ソースファイルは異なる拡張子を持つことができるため（.txtを好む人もいれば、.rstを好む人もいます - 拡張子はsource_suffixで設定できます）そして異なるOSは異なるパスセパレータを持つため、Sphinx はそれらを抽象化します。ドキュメント名は常にソースディレクトリを基準とした相対名であり、拡張子は削除され、パスセパレータはスラッシュに変換されます。「ドキュメント」を参照するすべての値、パラメータなどは、このようなドキュメント名を期待します。

ドキュメント名の例としては、index、library/zipfile、またはreference/datamodel/typesなどがあります。先頭または末尾にスラッシュはありません。

ドメイン¶

ドメインとは、マークアップ（reStructuredText ディレクティブとロール）の集合であり、プログラミング言語の要素など、一緒に属するオブジェクトを記述し、それらにリンクするために使用されます。ドメイン内のディレクティブとロールの名前はdomain:nameのような名前を持ちます（例：py:function）。

ドメインを使用することで、あるドキュメントセットがC++とPythonのクラスを参照する場合などに、名前の競合の問題が発生しません。また、まったく新しい言語のドキュメント作成をサポートする拡張機能をはるかに簡単に記述できるようになります。

詳細については、ドメインを参照してください。

環境¶

ルートの下にあるすべてのドキュメントに関する情報が保存され、相互参照に使用される構造です。環境は解析段階の後にピクル化されるため、後続の実行では、新しく変更されたドキュメントのみを読み取って解析する必要があります。

拡張機能¶

ユーザーがSphinx内のビルドプロセスのあらゆる側面を変更できる、カスタムロール、ディレクティブ、またはSphinxのその他の側面です。

詳細については、拡張機能を参照してください。

マスタードキュメント¶

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

ルートドキュメント¶

マスタードキュメントと同じです。

オブジェクト¶

Sphinx ドキュメントの基本的な構成要素です。すべての「オブジェクトディレクティブ」（例：py:functionまたはobject）は、このようなブロックを作成します。そして、ほとんどのオブジェクトは相互参照できます。

RemoveInSphinxXXXWarning¶

警告されている機能は、Sphinx-XXX バージョンで削除されます。通常、非推奨のものを利用している Sphinx 拡張機能によって発生します。非推奨警告も参照してください。

ロール¶

テキストの一部をマークアップすることを許可する reStructuredText マークアップ要素です。ディレクティブと同様に、ロールも拡張可能です。基本的な構文は次のようになります。:rolename:`content`。インラインマークアップの詳細を参照してください。

ソースディレクトリ¶

そのサブディレクトリを含む、1つのSphinxプロジェクトのすべてのソースファイルを含むディレクトリです。

reStructuredText¶

読みやすく、見たままのプレーンテキストマークアップ構文とパーサーシステムです。