blob: 3a936a6c4e134f7f4cab5169b863605402e7154d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
.. highlight:: rst
===========================
The reStructuredText Domain
===========================
.. versionadded:: 1.0
The reStructuredText domain (name **rst**) provides the following directives:
.. rst:directive:: .. rst:directive:: name
Describes a reST 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:
.. rst:directive:: foo
:no-contents-entry:
:no-index-entry:
Foo description.
.. rst:directive:: .. bar:: baz
:no-contents-entry:
:no-index-entry:
Bar description.
.. rst:directive:: .. 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
will be rendered as:
.. rst:directive:: toctree
:no-index:
.. rst:directive:option:: caption: caption of ToC
:no-index:
.. rst:directive:option:: glob
:no-index:
.. rubric:: options
.. rst:directive:option:: type: description of argument
:type: text
Describe the type of option value.
For example::
.. rst:directive:: toctree
.. rst:directive:option:: maxdepth
:type: integer or no value
.. versionadded:: 2.1
.. rst:directive:: .. rst:role:: name
Describes a reST role. For example::
.. rst:role:: foo
Foo description.
will be rendered as:
.. rst:role:: foo
:no-contents-entry:
:no-index-entry:
Foo description.
.. _rst-roles:
These roles are provided to refer to the described objects:
.. rst:role:: rst:dir
rst:role
|
