Deployed f36a3c8 with MkDocs version: 1.2.3

Author: pawamoy

reference/pytkdocs/index.html

@@ -12086,11 +12086,11 @@ <h5 id="pytkdocs.parsers.docstrings.numpy.Numpy" class="doc doc-heading">
 <span class="sd">        Parse a &quot;parameters&quot; section.</span>
 
 <span class="sd">        Arguments:</span>
-<span class="sd">            lines: The parameters block lines.</span>
-<span class="sd">            start_index: The line number to start at.</span>
+<span class="sd">            docstring: The raw docstring.</span>
+<span class="sd">            docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            A tuple containing a `Section` (or `None`) and the index at which to continue parsing.</span>
+<span class="sd">            A `Section` object (or `None` if section is empty).</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">parameters</span> <span class="o">=</span> <span class="p">[]</span>
 
@@ -12136,10 +12136,11 @@ <h5 id="pytkdocs.parsers.docstrings.numpy.Numpy" class="doc doc-heading">
 <span class="sd">        Parse an &quot;attributes&quot; section.</span>
 
 <span class="sd">        Arguments:</span>
+<span class="sd">            docstring: The raw docstring.</span>
 <span class="sd">            docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            A tuple containing a `Section` (or `None`).</span>
+<span class="sd">            A `Section` object (or `None` if section is empty).</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">attributes</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="n">docstring_attributes</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">params</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;attribute&quot;</span><span class="p">]</span>
@@ -12168,10 +12169,11 @@ <h5 id="pytkdocs.parsers.docstrings.numpy.Numpy" class="doc doc-heading">
 <span class="sd">        Parse an &quot;exceptions&quot; section.</span>
 
 <span class="sd">        Arguments:</span>
+<span class="sd">            docstring: The raw docstring.</span>
 <span class="sd">            docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            A tuple containing a `Section` (or `None`) and the index at which to continue parsing.</span>
+<span class="sd">            A `Section` object (or `None` if section is empty).</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">exceptions</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="n">except_obj</span> <span class="o">=</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">raises</span>
@@ -12196,7 +12198,7 @@ <h5 id="pytkdocs.parsers.docstrings.numpy.Numpy" class="doc doc-heading">
 <span class="sd">            docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            A tuple containing a `Section` (or `None`).</span>
+<span class="sd">            A `Section` object (or `None` if section is empty).</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">return_obj</span> <span class="o">=</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">returns</span> <span class="k">if</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">returns</span> <span class="k">else</span> <span class="p">[]</span>
         <span class="n">text</span> <span class="o">=</span> <span class="n">return_obj</span><span class="o">.</span><span class="n">description</span> <span class="k">if</span> <span class="n">return_obj</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
@@ -12228,10 +12230,11 @@ <h5 id="pytkdocs.parsers.docstrings.numpy.Numpy" class="doc doc-heading">
 <span class="sd">        Parse an &quot;examples&quot; section.</span>
 
 <span class="sd">        Arguments:</span>
+<span class="sd">            docstring: The raw docstring.</span>
 <span class="sd">            docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">        Returns:</span>
-<span class="sd">            A tuple containing a `Section` (or `None`).</span>
+<span class="sd">            A `Section` object (or `None` if section is empty).</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">text</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span>
             <span class="p">(</span>
@@ -12476,6 +12479,12 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_attributes_section" class="
     </tr>
   </thead>
   <tbody>
+      <tr>
+        <td><code>docstring</code></td>
+        <td><code>str</code></td>
+        <td><p>The raw docstring.</p></td>
+        <td><em>required</em></td>
+      </tr>
       <tr>
         <td><code>docstring_obj</code></td>
         <td><code>Docstring</code></td>
@@ -12495,7 +12504,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_attributes_section" class="
   <tbody>
     <tr>
       <td><code>Optional[pytkdocs.parsers.docstrings.base.Section]</code></td>
-      <td><p>A tuple containing a <code>Section</code> (or <code>None</code>).</p></td>
+      <td><p>A <code>Section</code> object (or <code>None</code> if section is empty).</p></td>
     </tr>
   </tbody>
 </table>
@@ -12510,10 +12519,11 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_attributes_section" class="
 <span class="sd">    Parse an &quot;attributes&quot; section.</span>
 
 <span class="sd">    Arguments:</span>
+<span class="sd">        docstring: The raw docstring.</span>
 <span class="sd">        docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        A tuple containing a `Section` (or `None`).</span>
+<span class="sd">        A `Section` object (or `None` if section is empty).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">attributes</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">docstring_attributes</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">params</span> <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;attribute&quot;</span><span class="p">]</span>
@@ -12565,6 +12575,12 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_examples_section" class="do
     </tr>
   </thead>
   <tbody>
+      <tr>
+        <td><code>docstring</code></td>
+        <td><code>str</code></td>
+        <td><p>The raw docstring.</p></td>
+        <td><em>required</em></td>
+      </tr>
       <tr>
         <td><code>docstring_obj</code></td>
         <td><code>Docstring</code></td>
@@ -12584,7 +12600,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_examples_section" class="do
   <tbody>
     <tr>
       <td><code>Optional[pytkdocs.parsers.docstrings.base.Section]</code></td>
-      <td><p>A tuple containing a <code>Section</code> (or <code>None</code>).</p></td>
+      <td><p>A <code>Section</code> object (or <code>None</code> if section is empty).</p></td>
     </tr>
   </tbody>
 </table>
@@ -12599,10 +12615,11 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_examples_section" class="do
 <span class="sd">    Parse an &quot;examples&quot; section.</span>
 
 <span class="sd">    Arguments:</span>
+<span class="sd">        docstring: The raw docstring.</span>
 <span class="sd">        docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        A tuple containing a `Section` (or `None`).</span>
+<span class="sd">        A `Section` object (or `None` if section is empty).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">text</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span>
         <span class="p">(</span>
@@ -12699,6 +12716,12 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_exceptions_section" class="
     </tr>
   </thead>
   <tbody>
+      <tr>
+        <td><code>docstring</code></td>
+        <td><code>str</code></td>
+        <td><p>The raw docstring.</p></td>
+        <td><em>required</em></td>
+      </tr>
       <tr>
         <td><code>docstring_obj</code></td>
         <td><code>Docstring</code></td>
@@ -12718,7 +12741,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_exceptions_section" class="
   <tbody>
     <tr>
       <td><code>Optional[pytkdocs.parsers.docstrings.base.Section]</code></td>
-      <td><p>A tuple containing a <code>Section</code> (or <code>None</code>) and the index at which to continue parsing.</p></td>
+      <td><p>A <code>Section</code> object (or <code>None</code> if section is empty).</p></td>
     </tr>
   </tbody>
 </table>
@@ -12733,10 +12756,11 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_exceptions_section" class="
 <span class="sd">    Parse an &quot;exceptions&quot; section.</span>
 
 <span class="sd">    Arguments:</span>
+<span class="sd">        docstring: The raw docstring.</span>
 <span class="sd">        docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        A tuple containing a `Section` (or `None`) and the index at which to continue parsing.</span>
+<span class="sd">        A `Section` object (or `None` if section is empty).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">exceptions</span> <span class="o">=</span> <span class="p">[]</span>
     <span class="n">except_obj</span> <span class="o">=</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">raises</span>
@@ -12783,15 +12807,15 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_parameters_section" class="
   </thead>
   <tbody>
       <tr>
-        <td><code>lines</code></td>
-        <td></td>
-        <td><p>The parameters block lines.</p></td>
+        <td><code>docstring</code></td>
+        <td><code>str</code></td>
+        <td><p>The raw docstring.</p></td>
         <td><em>required</em></td>
       </tr>
       <tr>
-        <td><code>start_index</code></td>
-        <td></td>
-        <td><p>The line number to start at.</p></td>
+        <td><code>docstring_obj</code></td>
+        <td><code>Docstring</code></td>
+        <td><p>Docstring object parsed by docstring_parser.</p></td>
         <td><em>required</em></td>
       </tr>
   </tbody>
@@ -12807,7 +12831,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_parameters_section" class="
   <tbody>
     <tr>
       <td><code>Optional[pytkdocs.parsers.docstrings.base.Section]</code></td>
-      <td><p>A tuple containing a <code>Section</code> (or <code>None</code>) and the index at which to continue parsing.</p></td>
+      <td><p>A <code>Section</code> object (or <code>None</code> if section is empty).</p></td>
     </tr>
   </tbody>
 </table>
@@ -12822,11 +12846,11 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_parameters_section" class="
 <span class="sd">    Parse a &quot;parameters&quot; section.</span>
 
 <span class="sd">    Arguments:</span>
-<span class="sd">        lines: The parameters block lines.</span>
-<span class="sd">        start_index: The line number to start at.</span>
+<span class="sd">        docstring: The raw docstring.</span>
+<span class="sd">        docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        A tuple containing a `Section` (or `None`) and the index at which to continue parsing.</span>
+<span class="sd">        A `Section` object (or `None` if section is empty).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">parameters</span> <span class="o">=</span> <span class="p">[]</span>
 
@@ -12914,7 +12938,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_return_section" class="doc
   <tbody>
     <tr>
       <td><code>Optional[pytkdocs.parsers.docstrings.base.Section]</code></td>
-      <td><p>A tuple containing a <code>Section</code> (or <code>None</code>).</p></td>
+      <td><p>A <code>Section</code> object (or <code>None</code> if section is empty).</p></td>
     </tr>
   </tbody>
 </table>
@@ -12931,7 +12955,7 @@ <h6 id="pytkdocs.parsers.docstrings.numpy.Numpy.read_return_section" class="doc
 <span class="sd">        docstring_obj: Docstring object parsed by docstring_parser.</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        A tuple containing a `Section` (or `None`).</span>
+<span class="sd">        A `Section` object (or `None` if section is empty).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">return_obj</span> <span class="o">=</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">returns</span> <span class="k">if</span> <span class="n">docstring_obj</span><span class="o">.</span><span class="n">returns</span> <span class="k">else</span> <span class="p">[]</span>
     <span class="n">text</span> <span class="o">=</span> <span class="n">return_obj</span><span class="o">.</span><span class="n">description</span> <span class="k">if</span> <span class="n">return_obj</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>