Directives in the reStructuredText domain¶
The domain name is rst
. See https://www.sphinx-doc.org/en/master/usage/domains/restructuredtext.html.
- .. my_directive::¶
The
.. rst:directive::
directive, showing the directivemy_directive
.
- .. my_directive2:: my_argument¶
The
.. rst:directive::
directive, showing the directivemy_directive2
with argumentmy_argument
.
- .. my_directive3::¶
The
.. rst:directive::
directive, showing the directivemy_directive3
.- :my_option1:¶
- :my_option2: my_argument¶
The
.. rst:directive:option::
directive, showing the directive optionmy_option2
that has an argument.
- :my_option3: my_argument2 (my_argument2_type)¶
The
.. rst:directive:option::
directive, showing the directive optionmy_option3
that has an argument with a type definition.
- :role_name:¶
The
.. rst:role::
directive, showing a role.