The reStructuredText Domain¶

Added in version 1.0.

The reStructuredText domain (name rst) provides the following directives:

.. rst:directive:: name¶

Describes a reStructuredText directive. The name can be a single directive name or actual directive syntax (.. prefix and :: suffix) with arguments that will be rendered differently. For example:

.. rst:directive:: foo

   Foo description.

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

   Bar description.

will be rendered as:

.. foo::¶: Foo description.

.. bar:: baz¶: Bar description.

.. rst:directive:option:: name¶

Describes an option for reStructuredText 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

will be rendered as:

.. toctree::

:caption: caption of ToC

:glob:

options

:type: description of argument (text)¶

Describe the type of option value.

For example:

.. rst:directive:: toctree

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

Added in version 2.1.

.. rst:role:: name¶

Describes a reStructuredText role. For example:

.. rst:role:: foo

   Foo description.

will be rendered as:

:foo:¶: Foo description.

These roles are provided to refer to the described objects:

:rst:dir:¶

Reference directives and directive options. Examples:

Use :rst:dir:`my-directive` to reference a directive.
Use :rst:dir:`my-directive:my-option` to reference a directive option.

:rst:role:¶: Reference a role. Example: :rst:role:`my-role`.