reStructuredText 域¶

在版本 1.0 中添加。

reStructuredText 域（名称 rst）提供以下指令

.. rst:directive:: name¶

描述 reStructuredText 指令。name 可以是单个指令名称，也可以是带有参数的实际指令语法（.. 前缀和 :: 后缀），这些参数将以不同方式渲染。例如

.. rst:directive:: foo

   Foo description.

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

   Bar description.

将渲染为

.. rst:directive:option:: name¶

描述 reStructuredText 指令的选项。name 可以是单个选项名称，也可以是带有参数的选项名称，这些参数用冒号 (:) 分隔。例如

.. rst:directive:: toctree

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

   .. rst:directive:option:: glob

将渲染为

.. toctree::

选项

:type: description of argument (text)¶

描述选项值的类型。

例如

.. rst:directive:: toctree

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

在版本 2.1 中添加。

.. rst:role:: name¶

描述 reStructuredText 角色。例如

.. rst:role:: foo

   Foo description.

将渲染为

这些角色用于引用所描述的对象