reStructuredTextドメイン

バージョン1.0で追加。

reStructuredTextドメイン（名前は rst ）は、以下のディレクティブを提供します

.. rst:directive:: name

reStructuredTextのディレクティブを記述します。name には、単一のディレクティブ名、または引数を持つ実際のディレクティブ構文（.. 接頭辞と :: 接尾辞）を指定できます。引数は異なる形でレンダリングされます。例：

.. rst:directive:: foo

   Foo description.

.. rst:directive:: .. bar:: baz

   Bar description.

は、次のようにレンダリングされます。

.. foo::

Fooの説明。

.. bar:: baz

Barの説明。

.. rst:directive:option:: name

reStructuredTextディレクティブのオプションを記述します。name には、単一のオプション名、またはコロン（:）で区切られた引数を持つオプション名を指定できます。例：

.. rst:directive:: toctree

   .. rst:directive:option:: caption: caption of ToC

   .. rst:directive:option:: glob

は、次のようにレンダリングされます。

.. toctree::
:caption: ToCのキャプション
:glob

オプション

:type: 引数の説明 (テキスト)

オプション値の型を記述します。

例：

.. rst:directive:: toctree

   .. rst:directive:option:: maxdepth
      :type: integer or no value

バージョン2.1で追加。

.. rst:role:: name

reStructuredTextのロールを記述します。例：

.. rst:role:: foo

   Foo description.

は、次のようにレンダリングされます。

:foo:

Fooの説明。

これらのロールは、記述されたオブジェクトを参照するために提供されます

:rst:dir:
:rst:role: