Skip to content

Commit

Permalink
docs: get params style return for napoleon
Browse files Browse the repository at this point in the history
  • Loading branch information
soymintc committed Jun 11, 2024
1 parent 4a6dc84 commit 4b80d3d
Showing 5 changed files with 20 additions and 73 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/ontmont.doctree
Binary file not shown.
90 changes: 18 additions & 72 deletions docs/_build/html/ontmont.html
Original file line number Diff line number Diff line change
@@ -344,10 +344,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-odd"><p><strong>bundle</strong> (<em>list</em>) – List of BreakpointChain</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Count of unique breakpoints, taking chrom, pos, ori into account</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pandas.Series</p>
<dd class="field-even"><p><strong>pandas.Series</strong> – Count of unique breakpoints, taking chrom, pos, ori into account</p>
</dd>
</dl>
</dd></dl>
@@ -366,10 +363,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>table of breakpoint coordinates with support and IR statistics</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pandas.DataFrame</p>
<dd class="field-even"><p><strong>pandas.DataFrame</strong> – table of breakpoint coordinates with support and IR statistics</p>
</dd>
</dl>
</dd></dl>
@@ -389,10 +383,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of BreakpointChain</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – list of BreakpointChain</p>
</dd>
</dl>
</dd></dl>
@@ -410,10 +401,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>table of segments coordinate with supports and IR statistics</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pandas.DataFrame</p>
<dd class="field-even"><p><strong>pandas.DataFrame</strong> – table of segments coordinate with supports and IR statistics</p>
</dd>
</dl>
</dd></dl>
@@ -430,10 +418,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Table of SVs, duplicate removed, removed if located on contig termini</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pandas.DataFrame</p>
<dd class="field-even"><p><strong>pandas.DataFrame</strong> – Table of SVs, duplicate removed, removed if located on contig termini</p>
</dd>
</dl>
</dd></dl>
@@ -456,10 +441,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of SplitAlignment objects</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – list of SplitAlignment objects</p>
</dd>
</dl>
</dd></dl>
@@ -477,10 +459,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><cite>{True, False}</cite> list of matches. Length equal to sv1 row size.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pd.Series</p>
<dd class="field-even"><p><strong>pd.Series</strong><cite>{True, False}</cite> list of matches. Length equal to sv1 row size.</p>
</dd>
</dl>
</dd></dl>
@@ -497,10 +476,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of BreakpointChain, mapped to fixed coordinates</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – List of BreakpointChain, mapped to fixed coordinates</p>
</dd>
</dl>
</dd></dl>
@@ -514,10 +490,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-odd"><p><strong>complexes</strong> (<em>list</em>) – List of BreakpointChain</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Support for str(Breakpoint) coordinates</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>collections.Counter</p>
<dd class="field-even"><p><strong>collections.Counter</strong> – Support for str(Breakpoint) coordinates</p>
</dd>
</dl>
</dd></dl>
@@ -531,10 +504,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-odd"><p><strong>tra</strong> (<a class="reference internal" href="#ontmont.datatypes.BreakpointPair" title="ontmont.datatypes.BreakpointPair"><em>BreakpointPair</em></a>) – Pair of breakpoints</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Sorted breakpoint coordinates, flattened</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – Sorted breakpoint coordinates, flattened</p>
</dd>
</dl>
</dd></dl>
@@ -551,10 +521,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-even"><p><strong>ValueError</strong> – If no SV type has been assigned</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>SV type string</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
<dd class="field-odd"><p><strong>str</strong> – SV type string</p>
</dd>
</dl>
</dd></dl>
@@ -568,10 +535,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd class="field-odd"><p><strong>reads_df</strong> (<em>pandas.DataFrame</em>) – Table of read alignment statistics</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of BreakpointChain</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – List of BreakpointChain</p>
</dd>
</dl>
</dd></dl>
@@ -590,10 +554,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>_description_</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>_type_</p>
<dd class="field-even"><p><strong>_type_</strong> – _description_</p>
</dd>
</dl>
</dd></dl>
@@ -611,10 +572,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(<cite>coord_map</cite>: src -&gt; dst coordinate, <cite>coord_map_log</cite> -&gt; (max_coord, src_count, max_count))</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple</p>
<dd class="field-even"><p><strong>tuple</strong> – (<cite>coord_map</cite>: src -&gt; dst coordinate, <cite>coord_map_log</cite> -&gt; (max_coord, src_count, max_count))</p>
</dd>
</dl>
</dd></dl>
@@ -636,10 +594,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Sorted (normalized) SV table</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>pandas.DataFrame</p>
<dd class="field-even"><p><strong>pandas.DataFrame</strong> – Sorted (normalized) SV table</p>
</dd>
</dl>
</dd></dl>
@@ -657,10 +612,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of BreakpointChain [, table of read alignment stats]</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list [, pandas.DataFrame]</p>
<dd class="field-even"><p><strong>list [, pandas.DataFrame]</strong> – List of BreakpointChain [, table of read alignment stats]</p>
</dd>
</dl>
</dd></dl>
@@ -680,10 +632,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of BreakpointChain</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – List of BreakpointChain</p>
</dd>
</dl>
</dd></dl>
@@ -700,10 +649,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Filtered list of BreakpointChain</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
<dd class="field-even"><p><strong>list</strong> – Filtered list of BreakpointChain</p>
</dd>
</dl>
</dd></dl>
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -39,6 +39,7 @@
napoleon_preprocess_types = False
napoleon_type_aliases = None
napoleon_attr_annotations = True
napoleon_custom_sections = [('Returns', 'params_style')]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

0 comments on commit 4b80d3d

Please sign in to comment.