用語表

建設者.

類(相続自) Builder )は、解析された文書を受け取り、操作を実行する。一般に、ビルダは、文書を出力フォーマットに変換するが、文書中の切断リンクをチェックしたり、カバー範囲情報を構築したりするなど、ビルダを使用してもよい。

見 建設者. ライオンの顔像の内蔵構築器について概説した。

構成ディレクトリ

以下の内容を含むディレクトリ conf.py それがそうです。デフォルトの場合これは source directory しかし、使用することができます -c コマンドラインオプション。

指令

特殊な意味を持つコンテンツブロックをマークすることを許すreStrucredTextタグ要素.コマンドはdocutilsによって提供されるだけでなく，Sphinxとカスタム拡張はそれら自身のコマンドを追加することができる.基本命令文法は以下のとおりである.

.. directivename:: argument ...
   :option: value

   Content of the directive.

見 指令 より多くの情報を得ることができます

文書名.

RESTソースファイルは異なる拡張子を持つことができるから(好きな人もいる .txt 好きな人もいます .rst --拡張は、 source_suffix )を有し、異なるオペレーティングシステムは異なるパス·セパレータを有し、Sphinxはそれを抽象化する： document names いつも相対的に source directory すると，拡張子を剥離し，ルーティングセパレータをスラッシュに変換する.“文書”を引用するすべての値，パラメータなどにはこのような文書名が必要である.

Examples for document names are index, library/zipfile, or reference/datamodel/types. Note that there is no leading or trailing slash.

域

属性ドメインはタグ(ReStructiredText)の集合である. directive sと role s)記述してリンクする object 一緒に属する、例えばプログラミング言語の要素。ドメイン内のコマンドとロール名の名前は以下のとおりである. domain:name 例えば、： py:function それがそうです。

ドメインを持つことは、文書のセットがC++およびPythonクラスを参照したい場合、名前付けの問題が発生しないことを意味します。これはまた新しい言語文書を支援する拡張が作成しやすいことを意味する。

詳細についてはご参照ください 網域. それがそうです。

環境.

ルートディレクトリ下のすべての文書に関する情報を保存し，交差参照の構造に用いる.環境は解析段階の後にフィルタリングを行うため，連続して実行するには新たな文書の読み出しと解析のみが必要である.

延伸する.

A custom role, directive or other aspect of Sphinx that allows users to modify any aspect of the build process within Sphinx.

詳細についてはご参照ください 延拓. それがそうです。

主文書.

ルートディレクトリを含む文書 toctree 指令する。

客体.

Sphinx文書の基本構築ブロック.各“オブジェクトコマンド”(例えば function あるいは…。 object )このようなブロックを作成し、ほとんどのオブジェクトは交差参照することができる。

RemoveInSphinxXXXWarning

警告された機能は、Sphinx-XXXバージョンで削除されます。それは一般的に使用放棄されたSphinx拡張によって引き起こされる。また見られる. 警告のご利用はおすすめしておりません それがそうです。

役柄

テキストのreStrupredTextタグ要素をタグ付けすることを許可する.指示と同じように、役割も拡張可能だ。基本文法は以下のとおりである. :rolename:`content .見 :ref:`rst-inline-markup もっと細かいことを知っています。

ソースディレクトリ.

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

RedTextを再構築する

読みやすく、見やすい、すなわち得られる純粋なテキストタグ文法および解析器システム。