summaryrefslogtreecommitdiffstats
path: root/tests/test_sphinx/test_sphinx_builds/test_fieldlist_extension.sphinx4.html
blob: bef86e925508b88072d578b3864b6b0430915aac (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<div class="documentwrapper">
 <div class="bodywrapper">
  <div class="body" role="main">
   <section id="test">
    <h1>
     Test
     <a class="headerlink" href="#test" title="Permalink to this headline"></a>
    </h1>
    <dl class="myst field-list simple">
     <dt class="field-odd">
      field
     </dt>
     <dd class="field-odd">
      <p>
      </p>
     </dd>
     <dt class="field-even">
      <em>
       field
      </em>
     </dt>
     <dd class="field-even">
      <p>
       content
      </p>
     </dd>
    </dl>
    <dl class="py function">
     <dt class="sig sig-object py" id="send_message">
      <span class="sig-name descname">
       <span class="pre">
        send_message
       </span>
      </span>
      <span class="sig-paren">
       (
      </span>
      <em class="sig-param">
       <span class="n">
        <span class="pre">
         sender
        </span>
       </span>
      </em>
      ,
      <em class="sig-param">
       <span class="n">
        <span class="pre">
         priority
        </span>
       </span>
      </em>
      <span class="sig-paren">
       )
      </span>
      <a class="headerlink" href="#send_message" title="Permalink to this definition"></a>
     </dt>
     <dd>
      <p>
       Send a message to a recipient
      </p>
      <dl class="myst field-list simple">
       <dt class="field-odd">
        Parameters
       </dt>
       <dd class="field-odd">
        <ul class="simple">
         <li>
          <p>
           <strong>
            sender
           </strong>
           (
           <em>
            str
           </em>
           ) – The person sending the message
          </p>
         </li>
         <li>
          <p>
           <strong>
            priority
           </strong>
           (
           <em>
            int
           </em>
           ) – The priority of the message, can be a number 1-5
          </p>
         </li>
        </ul>
       </dd>
       <dt class="field-even">
        Returns
       </dt>
       <dd class="field-even">
        <p>
         the message id
        </p>
       </dd>
       <dt class="field-odd">
        Return type
       </dt>
       <dd class="field-odd">
        <p>
         int
        </p>
       </dd>
       <dt class="field-even">
        Raises
       </dt>
       <dd class="field-even">
        <p>
         <strong>
          ValueError
         </strong>
         – if the message_body exceeds 160 characters
        </p>
       </dd>
      </dl>
     </dd>
    </dl>
   </section>
  </div>
 </div>
</div>