The reStructuredText Domain¶
Added in version 1.0.
reStructuredTextドメイン(rst)は、次のようなディレクティブを提供します:
- .. rst:directive:: name¶
reSTディレクティブの説明をします。 name には単独のディレクティブ名か、引数付きの実際のディレクティブの文法(.. を前に付けたり、後ろに :: を付けたり)で記述をします。例:
.. rst:directive:: foo Foo description. .. rst:directive:: .. bar:: baz Bar description.
これは次のようにレンダリングされます
- .. foo::¶
Fooの説明
- .. bar:: baz¶
Barの説明
- .. rst:directive:option:: name¶
Describes an option for reST directive. The name can be a single option name or option name with arguments which separated with colon (
:
). For example:.. rst:directive:: toctree .. rst:directive:option:: caption: caption of ToC .. rst:directive:option:: glob
これは次のようにレンダリングされます
- .. toctree::
- :caption: caption of ToC
- :glob:
options
- :type: description of argument (text)¶
Describe the type of option value.
例えば:
.. rst:directive:: toctree .. rst:directive:option:: maxdepth :type: integer or no value
Added in version 2.1.
- .. rst:role:: name¶
reSTのロールの説明をします。 例:
.. rst:role:: foo Foo description.
これは次のようにレンダリングされます
- :foo:¶
Fooの説明
このドメインでは、オブジェクトの説明を参照する、次のようなロールが提供されています: