update docstring

This commit is contained in:
2026-01-22 18:50:07 +01:00
parent d0eabd3252
commit 22cc4f2943
46 changed files with 3647 additions and 1624 deletions

View File

@@ -39,7 +39,40 @@
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">pylib</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pylib.html">pylib package</a></li>
<li class="toctree-l2"><a class="reference internal" href="pylib.html">pylib package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="pylib.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pylib.numerical.html">pylib.numerical package</a><ul>
<li class="toctree-l5"><a class="reference internal" href="pylib.numerical.html#submodules">Submodules</a><ul>
<li class="toctree-l6"><a class="reference internal" href="pylib.numerical.fit.html">pylib.numerical.fit module</a></li>
<li class="toctree-l6"><a class="reference internal" href="pylib.numerical.integration.html">pylib.numerical.integration module</a></li>
<li class="toctree-l6"><a class="reference internal" href="pylib.numerical.ode.html">pylib.numerical.ode module</a></li>
<li class="toctree-l6"><a class="reference internal" href="pylib.numerical.ode_model.html">pylib.numerical.ode_model module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pylib.html#submodules">Submodules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="pylib.data.html">pylib.data module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.data_step.html">pylib.data_step module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.data_step_std.html">pylib.data_step_std module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.date.html">pylib.date module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.drawblock.html">pylib.drawblock module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.function.html">pylib.function module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.geometry.html">pylib.geometry module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.geometry2d.html">pylib.geometry2d module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.geometry2d_plot.html">pylib.geometry2d_plot module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.geometry_plot.html">pylib.geometry_plot module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.geometry_plot_pylab.html">pylib.geometry_plot_pylab module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.helper.html">pylib.helper module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.mathematics.html">pylib.mathematics module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.time_of_day.html">pylib.time_of_day module</a></li>
<li class="toctree-l4"><a class="reference internal" href="pylib.tui.html">pylib.tui module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
@@ -52,13 +85,17 @@
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
<div class="section" id="data-step-std">
<h2><code class="docutils literal notranslate"><span class="pre">data_step_std</span></code><a class="headerlink" href="#data-step-std" title="Permalink to this headline"></a></h2>
<a class="reference external image-reference" href="_images/class_diagram.svg"><img alt="_images/class_diagram.svg" src="_images/class_diagram.svg" /></a>
</div>
<div class="section" id="tui">
<h2>tui<a class="headerlink" href="#tui" title="Permalink to this headline"></a></h2>
<p>pylib/tui.py is the main module for tui terminal user interface programs.</p>
<h2><code class="docutils literal notranslate"><span class="pre">tui</span></code><a class="headerlink" href="#tui" title="Permalink to this headline"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pylib/tui.py</span></code> is the main module for tui textual user interface programs.</p>
<ul class="simple">
<li><p>curses package (for Windows install windows-curses) is the underlying main
package to build terminal programs. The curses package can also be used
directly.</p>
<li><p><code class="docutils literal notranslate"><span class="pre">curses</span></code> package (for Windows install <code class="docutils literal notranslate"><span class="pre">windows-curses</span></code>) is the underlying
main package to build terminal programs. The <code class="docutils literal notranslate"><span class="pre">curses</span></code> package can also be
used directly.</p>
<ul>
<li><p>Windows (Anaconda):</p>
<ul>
@@ -69,9 +106,9 @@ directly.</p>
</li>
</ul>
</li>
<li><p>drawille package is used to draw with braille characters (dottet and quasi-
line charts). Make sure you use a font with Unicode Braille characters. For
Windows e. g.: NSimSun, MS Gothic.</p>
<li><p><code class="docutils literal notranslate"><span class="pre">drawille</span></code> package is used to draw with braille characters (dottet and
quasi-line charts). Make sure you use a font with Unicode Braille characters.
For Windows e. g.: NSimSun, MS Gothic.</p>
<ul>
<li><p>Install: <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pip</span> <span class="pre">install</span> <span class="pre">drawille</span></code></p></li>
<li><p>Windows (Anaconda):</p>
@@ -82,9 +119,9 @@ Windows e. g.: NSimSun, MS Gothic.</p>
</li>
</ul>
</li>
<li><p>drawblock.py is used to draw with block characters (histogram).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drawblock</span></code> is used to draw with block characters (histogram).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">example/tui.py</span></code> is an example script to build a terminal program.</p></li>
</ul>
<p>example/tui.py is an example script to build a terminal program.</p>
</div>
</div>