|
| 1 | +<!-- |
| 2 | +{ |
| 3 | + "filters": [ |
| 4 | + "module_attribute" |
| 5 | + ], |
| 6 | + "inherited_members": true, |
| 7 | + "members": true |
| 8 | +} |
| 9 | +--> |
| 10 | + |
| 11 | +<div class="doc doc-object doc-module"> |
| 12 | + <a id="pkg"> |
| 13 | + </a> |
| 14 | + <div class="doc doc-contents first"> |
| 15 | + <div class="doc doc-children"> |
| 16 | + <div class="doc doc-object doc-attribute"> |
| 17 | + <h2 class="doc doc-heading" id="pkg.module_attribute"> |
| 18 | + <code class="highlight language-python"> |
| 19 | + <span class="n"> |
| 20 | + module_attribute |
| 21 | + </span> |
| 22 | + <span class="o"> |
| 23 | + = |
| 24 | + </span> |
| 25 | + <span class="mi"> |
| 26 | + 42 |
| 27 | + </span> |
| 28 | + </code> |
| 29 | + <span class="doc doc-labels"> |
| 30 | + <small class="doc doc-label doc-label-module-attribute"> |
| 31 | + <code> |
| 32 | + module-attribute |
| 33 | + </code> |
| 34 | + </small> |
| 35 | + </span> |
| 36 | + </h2> |
| 37 | + <div class="doc doc-contents"> |
| 38 | + <p> |
| 39 | + Docstring for |
| 40 | + <code> |
| 41 | + module_attribute |
| 42 | + </code> |
| 43 | + . |
| 44 | + </p> |
| 45 | + </div> |
| 46 | + </div> |
| 47 | + <div class="doc doc-object doc-class"> |
| 48 | + <h2 class="doc doc-heading" id="pkg.Class"> |
| 49 | + <code> |
| 50 | + Class |
| 51 | + </code> |
| 52 | + </h2> |
| 53 | + <div class="doc doc-contents"> |
| 54 | + <p> |
| 55 | + Docstring for |
| 56 | + <code> |
| 57 | + Class |
| 58 | + </code> |
| 59 | + . |
| 60 | + </p> |
| 61 | + <details class="quote"> |
| 62 | + <summary> |
| 63 | + Source code in |
| 64 | + <code> |
| 65 | + pkg/__init__.py |
| 66 | + </code> |
| 67 | + </summary> |
| 68 | + <div class="highlight"> |
| 69 | + <table class="highlighttable"> |
| 70 | + <tr> |
| 71 | + <td class="linenos"> |
| 72 | + <div class="linenodiv"> |
| 73 | + <pre><span></span><span class="normal"> 5</span> |
| 74 | +<span class="normal"> 6</span> |
| 75 | +<span class="normal"> 7</span> |
| 76 | +<span class="normal"> 8</span> |
| 77 | +<span class="normal"> 9</span> |
| 78 | +<span class="normal">10</span> |
| 79 | +<span class="normal">11</span> |
| 80 | +<span class="normal">12</span> |
| 81 | +<span class="normal">13</span> |
| 82 | +<span class="normal">14</span> |
| 83 | +<span class="normal">15</span> |
| 84 | +<span class="normal">16</span> |
| 85 | +<span class="normal">17</span> |
| 86 | +<span class="normal">18</span> |
| 87 | +<span class="normal">19</span> |
| 88 | +<span class="normal">20</span> |
| 89 | +<span class="normal">21</span> |
| 90 | +<span class="normal">22</span> |
| 91 | +<span class="normal">23</span></pre> |
| 92 | + </div> |
| 93 | + </td> |
| 94 | + <td class="code"> |
| 95 | + <div> |
| 96 | + <pre><span></span><code><span class="k">class</span> <span class="nc">Class</span><span class="p">:</span> |
| 97 | +<span class="w"> </span><span class="sd">'''Docstring for `Class`.'''</span> |
| 98 | + |
| 99 | + <span class="k">class</span> <span class="nc">NestedClass</span><span class="p">:</span> |
| 100 | +<span class="w"> </span><span class="sd">'''Docstring for `NestedClass`.'''</span> |
| 101 | + |
| 102 | + <span class="n">class_attribute</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">42</span> |
| 103 | +<span class="w"> </span><span class="sd">'''Docstring for `Class.class_attribute`.'''</span> |
| 104 | + |
| 105 | + <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 106 | +<span class="w"> </span><span class="sd">'''Docstring for `Class.__init__`.'''</span> |
| 107 | + <span class="bp">self</span><span class="o">.</span><span class="n">instance_attribute</span> <span class="o">=</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span> |
| 108 | +<span class="w"> </span><span class="sd">'''Docstring for `Class.instance_attribute`.'''</span> |
| 109 | + |
| 110 | + <span class="k">def</span> <span class="nf">method1</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 111 | +<span class="w"> </span><span class="sd">'''Docstring for `Class.method1`.'''</span> |
| 112 | + |
| 113 | + <span class="k">def</span> <span class="nf">method2</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 114 | +<span class="w"> </span><span class="sd">'''Docstring for `Class.method2`.'''</span> |
| 115 | +</code></pre> |
| 116 | + </div> |
| 117 | + </td> |
| 118 | + </tr> |
| 119 | + </table> |
| 120 | + </div> |
| 121 | + </details> |
| 122 | + <div class="doc doc-children"> |
| 123 | + </div> |
| 124 | + </div> |
| 125 | + </div> |
| 126 | + <div class="doc doc-object doc-class"> |
| 127 | + <h2 class="doc doc-heading" id="pkg.Subclass"> |
| 128 | + <code> |
| 129 | + Subclass |
| 130 | + </code> |
| 131 | + </h2> |
| 132 | + <div class="doc doc-contents"> |
| 133 | + <p class="doc doc-class-bases"> |
| 134 | + Bases: |
| 135 | + <code> |
| 136 | + <autoref hover="" identifier="pkg.Class" optional=""> |
| 137 | + Class |
| 138 | + </autoref> |
| 139 | + </code> |
| 140 | + </p> |
| 141 | + <p> |
| 142 | + Docstring for |
| 143 | + <code> |
| 144 | + Subclass |
| 145 | + </code> |
| 146 | + . |
| 147 | + </p> |
| 148 | + <details class="quote"> |
| 149 | + <summary> |
| 150 | + Source code in |
| 151 | + <code> |
| 152 | + pkg/__init__.py |
| 153 | + </code> |
| 154 | + </summary> |
| 155 | + <div class="highlight"> |
| 156 | + <table class="highlighttable"> |
| 157 | + <tr> |
| 158 | + <td class="linenos"> |
| 159 | + <div class="linenodiv"> |
| 160 | + <pre><span></span><span class="normal">28</span> |
| 161 | +<span class="normal">29</span></pre> |
| 162 | + </div> |
| 163 | + </td> |
| 164 | + <td class="code"> |
| 165 | + <div> |
| 166 | + <pre><span></span><code><span class="k">class</span> <span class="nc">Subclass</span><span class="p">(</span><span class="n">Class</span><span class="p">):</span> |
| 167 | +<span class="w"> </span><span class="sd">'''Docstring for `Subclass`.'''</span> |
| 168 | +</code></pre> |
| 169 | + </div> |
| 170 | + </td> |
| 171 | + </tr> |
| 172 | + </table> |
| 173 | + </div> |
| 174 | + </details> |
| 175 | + <div class="doc doc-children"> |
| 176 | + </div> |
| 177 | + </div> |
| 178 | + </div> |
| 179 | + <div class="doc doc-object doc-function"> |
| 180 | + <h2 class="doc doc-heading" id="pkg.module_function"> |
| 181 | + <code class="highlight language-python"> |
| 182 | + <span class="n"> |
| 183 | + module_function |
| 184 | + </span> |
| 185 | + <span class="p"> |
| 186 | + ( |
| 187 | + </span> |
| 188 | + <span class="n"> |
| 189 | + a |
| 190 | + </span> |
| 191 | + <span class="p"> |
| 192 | + , |
| 193 | + </span> |
| 194 | + <span class="n"> |
| 195 | + b |
| 196 | + </span> |
| 197 | + <span class="p"> |
| 198 | + ) |
| 199 | + </span> |
| 200 | + </code> |
| 201 | + </h2> |
| 202 | + <div class="doc doc-contents"> |
| 203 | + <p> |
| 204 | + Docstring for |
| 205 | + <code> |
| 206 | + module_function |
| 207 | + </code> |
| 208 | + . |
| 209 | + </p> |
| 210 | + <details class="quote"> |
| 211 | + <summary> |
| 212 | + Source code in |
| 213 | + <code> |
| 214 | + pkg/__init__.py |
| 215 | + </code> |
| 216 | + </summary> |
| 217 | + <div class="highlight"> |
| 218 | + <table class="highlighttable"> |
| 219 | + <tr> |
| 220 | + <td class="linenos"> |
| 221 | + <div class="linenodiv"> |
| 222 | + <pre><span></span><span class="normal">2</span> |
| 223 | +<span class="normal">3</span></pre> |
| 224 | + </div> |
| 225 | + </td> |
| 226 | + <td class="code"> |
| 227 | + <div> |
| 228 | + <pre><span></span><code><span class="k">def</span> <span class="nf">module_function</span><span class="p">(</span><span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| 229 | +<span class="w"> </span><span class="sd">'''Docstring for `module_function`.'''</span> |
| 230 | +</code></pre> |
| 231 | + </div> |
| 232 | + </td> |
| 233 | + </tr> |
| 234 | + </table> |
| 235 | + </div> |
| 236 | + </details> |
| 237 | + </div> |
| 238 | + </div> |
| 239 | + </div> |
| 240 | + </div> |
| 241 | +</div> |
0 commit comments