/
test_fieldlist_extension.sphinx3.xml
82 lines (82 loc) · 3.99 KB
/
test_fieldlist_extension.sphinx3.xml
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
<document source="index.md">
<section ids="test" names="test">
<title>
Test
<field_list classes="myst">
<field>
<field_name>
field
<field_body>
<field>
<field_name>
<emphasis>
field
<field_body>
<paragraph>
content
<index entries="('pair',\ 'built-in\ function;\ send_message()',\ 'send_message',\ '',\ None)">
<desc classes="py" desctype="function" domain="py" noindex="False" objtype="function">
<desc_signature class="" fullname="send_message" ids="send_message" module="True">
<desc_name xml:space="preserve">
send_message
<desc_parameterlist xml:space="preserve">
<desc_parameter xml:space="preserve">
<desc_sig_name classes="n">
sender
<desc_parameter xml:space="preserve">
<desc_sig_name classes="n">
priority
<desc_content>
<paragraph>
Send a message to a recipient
<field_list classes="myst">
<field>
<field_name>
Parameters
<field_body>
<bullet_list>
<list_item>
<paragraph>
<literal_strong>
sender
(
<pending_xref py:class="True" py:module="True" refdomain="py" refexplicit="False" refspecific="True" reftarget="str" reftype="class">
<literal_emphasis>
str
)
–
The person sending the message
<list_item>
<paragraph>
<literal_strong>
priority
(
<pending_xref py:class="True" py:module="True" refdomain="py" refexplicit="False" refspecific="True" reftarget="int" reftype="class">
<literal_emphasis>
int
)
–
The priority of the message, can be a number 1-5
<field>
<field_name>
Returns
<field_body>
<paragraph>
the message id
<field>
<field_name>
Return type
<field_body>
<paragraph>
<pending_xref py:class="True" py:module="True" refdomain="py" refexplicit="False" refspecific="True" reftarget="int" reftype="class">
int
<field>
<field_name>
Raises
<field_body>
<paragraph>
<pending_xref py:class="True" py:module="True" refdomain="py" refexplicit="False" refspecific="True" reftarget="ValueError" reftype="exc">
<literal_strong>
ValueError
–
if the message_body exceeds 160 characters