Updated documentation and built doc website

This commit is contained in:
2024-12-02 16:31:03 +01:00
parent 23e0ced190
commit f3bb82a937
21 changed files with 1657 additions and 60 deletions

View File

@ -75,11 +75,8 @@
<li class="toctree-l2"><a class="reference internal" href="#src.hdf5_writer.save_processed_dataframe_to_hdf5"><code class="docutils literal notranslate"><span class="pre">save_processed_dataframe_to_hdf5()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="#module-src.hdf5_vis">Data Visualization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#src.hdf5_vis.display_group_hierarchy_on_a_treemap"><code class="docutils literal notranslate"><span class="pre">display_group_hierarchy_on_a_treemap()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pipelines.html">Pipelines and workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="vis.html">Data Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Data Structure Conversion</a></li>
<li class="toctree-l1"><a class="reference internal" href="notebooks.html">Notebooks</a></li>
</ul>
@ -427,15 +424,6 @@ output_filename (str): Path to the source HDF5 file.</p>
</dl>
</dd></dl>
</section>
<section id="module-src.hdf5_vis">
<span id="data-visualization"></span><h1>Data Visualization<a class="headerlink" href="#module-src.hdf5_vis" title="Link to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="src.hdf5_vis.display_group_hierarchy_on_a_treemap">
<span class="sig-prename descclassname"><span class="pre">src.hdf5_vis.</span></span><span class="sig-name descname"><span class="pre">display_group_hierarchy_on_a_treemap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/src/hdf5_vis.html#display_group_hierarchy_on_a_treemap"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#src.hdf5_vis.display_group_hierarchy_on_a_treemap" title="Link to this definition"></a></dt>
<dd><p>filename (str): hdf5 files filename</p>
</dd></dl>
</section>