docs update

This commit is contained in:
Dirk Alders 2025-08-17 11:18:46 +02:00
parent 9054a66a6d
commit e8d878604f
8 changed files with 35 additions and 39 deletions

View File

@ -1,4 +0,0 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d497de9a4dddf5e31c714de693c3c3e1
tags: 645f666f9bcd5a90fca523b33c5a78b7

View File

@ -139,10 +139,10 @@
<h2 id="B">B</h2> <h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.csp.build_frame">build_frame() (in module stringtools.csp)</a> <li><a href="stringtools.html#stringtools.csp.build_frame">build_frame() (in module stringtools.csp)</a>
<ul> <ul>
<li><a href="index.html#stringtools.stp.build_frame">(in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.build_frame">(in module stringtools.stp)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -151,7 +151,7 @@
<h2 id="C">C</h2> <h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.csp.csp">csp (class in stringtools.csp)</a> <li><a href="stringtools.html#stringtools.csp.csp">csp (class in stringtools.csp)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -159,15 +159,15 @@
<h2 id="D">D</h2> <h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.stp.DATA_CLEAR_BUFFER">DATA_CLEAR_BUFFER (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.DATA_CLEAR_BUFFER">DATA_CLEAR_BUFFER (in module stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.DATA_STORE_SYNC_VALUE">DATA_STORE_SYNC_VALUE (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.DATA_STORE_SYNC_VALUE">DATA_STORE_SYNC_VALUE (in module stringtools.stp)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.stp.DATA_SYNC">DATA_SYNC (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.DATA_SYNC">DATA_SYNC (in module stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.DATA_VALID_MSG">DATA_VALID_MSG (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.DATA_VALID_MSG">DATA_VALID_MSG (in module stringtools.stp)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -175,11 +175,11 @@
<h2 id="G">G</h2> <h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.gzip_compress">gzip_compress() (in module stringtools)</a> <li><a href="stringtools.html#stringtools.gzip_compress">gzip_compress() (in module stringtools)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.gzip_extract">gzip_extract() (in module stringtools)</a> <li><a href="stringtools.html#stringtools.gzip_extract">gzip_extract() (in module stringtools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -187,7 +187,7 @@
<h2 id="H">H</h2> <h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.hexlify">hexlify() (in module stringtools)</a> <li><a href="stringtools.html#stringtools.hexlify">hexlify() (in module stringtools)</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -195,10 +195,10 @@
<h2 id="L">L</h2> <h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.csp.csp.LOG_PREFIX">LOG_PREFIX (stringtools.csp.csp attribute)</a> <li><a href="stringtools.html#stringtools.csp.csp.LOG_PREFIX">LOG_PREFIX (stringtools.csp.csp attribute)</a>
<ul> <ul>
<li><a href="index.html#stringtools.stp.stp.LOG_PREFIX">(stringtools.stp.stp attribute)</a> <li><a href="stringtools.html#stringtools.stp.stp.LOG_PREFIX">(stringtools.stp.stp attribute)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -211,11 +211,11 @@
module module
<ul> <ul>
<li><a href="index.html#module-stringtools">stringtools</a> <li><a href="stringtools.html#module-stringtools">stringtools</a>
</li> </li>
<li><a href="index.html#module-stringtools.csp">stringtools.csp</a> <li><a href="stringtools.html#module-stringtools.csp">stringtools.csp</a>
</li> </li>
<li><a href="index.html#module-stringtools.stp">stringtools.stp</a> <li><a href="stringtools.html#module-stringtools.stp">stringtools.stp</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -224,10 +224,10 @@
<h2 id="P">P</h2> <h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.csp.csp.process">process() (stringtools.csp.csp method)</a> <li><a href="stringtools.html#stringtools.csp.csp.process">process() (stringtools.csp.csp method)</a>
<ul> <ul>
<li><a href="index.html#stringtools.stp.stp.process">(stringtools.stp.stp method)</a> <li><a href="stringtools.html#stringtools.stp.stp.process">(stringtools.stp.stp method)</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>
@ -236,15 +236,15 @@
<h2 id="S">S</h2> <h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#stringtools.stp.stp">stp (class in stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.stp">stp (class in stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.STP_STATE_ESCAPE_1">STP_STATE_ESCAPE_1 (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.STP_STATE_ESCAPE_1">STP_STATE_ESCAPE_1 (in module stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.STP_STATE_ESCAPE_2">STP_STATE_ESCAPE_2 (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.STP_STATE_ESCAPE_2">STP_STATE_ESCAPE_2 (in module stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.STP_STATE_IDLE">STP_STATE_IDLE (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.STP_STATE_IDLE">STP_STATE_IDLE (in module stringtools.stp)</a>
</li> </li>
<li><a href="index.html#stringtools.stp.STP_STATE_STORE_DATA">STP_STATE_STORE_DATA (in module stringtools.stp)</a> <li><a href="stringtools.html#stringtools.stp.STP_STATE_STORE_DATA">STP_STATE_STORE_DATA (in module stringtools.stp)</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
@ -252,21 +252,21 @@
stringtools stringtools
<ul> <ul>
<li><a href="index.html#module-stringtools">module</a> <li><a href="stringtools.html#module-stringtools">module</a>
</li> </li>
</ul></li> </ul></li>
<li> <li>
stringtools.csp stringtools.csp
<ul> <ul>
<li><a href="index.html#module-stringtools.csp">module</a> <li><a href="stringtools.html#module-stringtools.csp">module</a>
</li> </li>
</ul></li> </ul></li>
<li> <li>
stringtools.stp stringtools.stp
<ul> <ul>
<li><a href="index.html#module-stringtools.stp">module</a> <li><a href="stringtools.html#module-stringtools.stp">module</a>
</li> </li>
</ul></li> </ul></li>
</ul></td> </ul></td>

Binary file not shown.

View File

@ -139,17 +139,17 @@
<td><img src="_static/minus.png" class="toggler" <td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td> id="toggle-1" style="display: none" alt="-" /></td>
<td> <td>
<a href="index.html#module-stringtools"><code class="xref">stringtools</code></a></td><td> <a href="stringtools.html#module-stringtools"><code class="xref">stringtools</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr class="cg-1"> <tr class="cg-1">
<td></td> <td></td>
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="index.html#module-stringtools.csp"><code class="xref">stringtools.csp</code></a></td><td> <a href="stringtools.html#module-stringtools.csp"><code class="xref">stringtools.csp</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
<tr class="cg-1"> <tr class="cg-1">
<td></td> <td></td>
<td>&#160;&#160;&#160; <td>&#160;&#160;&#160;
<a href="index.html#module-stringtools.stp"><code class="xref">stringtools.stp</code></a></td><td> <a href="stringtools.html#module-stringtools.stp"><code class="xref">stringtools.stp</code></a></td><td>
<em></em></td></tr> <em></em></td></tr>
</table> </table>

File diff suppressed because one or more lines are too long

View File

@ -103,7 +103,7 @@
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/stringtools.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -138,7 +138,7 @@
</li> </li>
<li> <li>
<a href="#">stringtools documentation</a> &#187; <a href="index.html">stringtools documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">stringtools package</a></li> <li class="nav-item nav-item-this"><a href="">stringtools package</a></li>
@ -193,7 +193,7 @@
</ul> </ul>
<p><strong>Unittest:</strong></p> <p><strong>Unittest:</strong></p>
<blockquote> <blockquote>
<div><p>See also the <a class="reference download internal" download="" href="_downloads/084de37e91cd5556912de3caf4c229f8/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p> <div><p>See also the <a class="reference download internal" download="" href="_downloads/74bf2d266ab1f5e92547a96f9516e30f/unittest.pdf"><code class="xref download docutils literal notranslate"><span class="pre">unittest</span></code></a> documentation.</p>
</div></blockquote> </div></blockquote>
<p><strong>Module Documentation:</strong></p> <p><strong>Module Documentation:</strong></p>
</section> </section>
@ -228,7 +228,7 @@
</div> </div>
<p>Will result to the following output:</p> <p>Will result to the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">DEBUG</span> <span class="o">-</span> <span class="n">stringtools</span> <span class="o">-</span> <span class="n">GZIP</span><span class="p">:</span> <span class="n">Finished</span> <span class="n">to</span> <span class="n">compress</span> <span class="n">a</span> <span class="n">string</span> <span class="p">(</span><span class="n">compression_rate</span><span class="o">=</span><span class="mf">0.867</span><span class="p">,</span> <span class="n">consumed_time</span><span class="o">=</span><span class="mf">0.0</span><span class="n">s</span><span class="p">)</span><span class="o">.</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="n">DEBUG</span> <span class="o">-</span> <span class="n">stringtools</span> <span class="o">-</span> <span class="n">GZIP</span><span class="p">:</span> <span class="n">Finished</span> <span class="n">to</span> <span class="n">compress</span> <span class="n">a</span> <span class="n">string</span> <span class="p">(</span><span class="n">compression_rate</span><span class="o">=</span><span class="mf">0.867</span><span class="p">,</span> <span class="n">consumed_time</span><span class="o">=</span><span class="mf">0.0</span><span class="n">s</span><span class="p">)</span><span class="o">.</span>
<span class="p">(</span><span class="mi">26</span><span class="p">):</span> <span class="mi">1</span><span class="n">f</span> <span class="mi">8</span><span class="n">b</span> <span class="mi">08</span> <span class="mi">00</span> <span class="n">d1</span> <span class="mi">64</span> <span class="mi">9</span><span class="n">e</span> <span class="mi">68</span> <span class="mi">02</span> <span class="n">ff</span> <span class="mi">63</span> <span class="mi">60</span> <span class="mi">40</span> <span class="mi">01</span> <span class="n">ff</span> <span class="mi">51</span> <span class="mi">01</span> <span class="mi">00</span> <span class="mi">2</span><span class="n">d</span> <span class="mi">8</span><span class="n">a</span> <span class="mi">7</span><span class="n">d</span> <span class="n">de</span> <span class="mi">1</span><span class="n">e</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="p">(</span><span class="mi">26</span><span class="p">):</span> <span class="mi">1</span><span class="n">f</span> <span class="mi">8</span><span class="n">b</span> <span class="mi">08</span> <span class="mi">00</span> <span class="mi">9</span><span class="n">f</span> <span class="mi">9</span><span class="n">a</span> <span class="n">a1</span> <span class="mi">68</span> <span class="mi">02</span> <span class="n">ff</span> <span class="mi">63</span> <span class="mi">60</span> <span class="mi">40</span> <span class="mi">01</span> <span class="n">ff</span> <span class="mi">51</span> <span class="mi">01</span> <span class="mi">00</span> <span class="mi">2</span><span class="n">d</span> <span class="mi">8</span><span class="n">a</span> <span class="mi">7</span><span class="n">d</span> <span class="n">de</span> <span class="mi">1</span><span class="n">e</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span>
</pre></div> </pre></div>
</div> </div>
</dd></dl> </dd></dl>
@ -615,7 +615,7 @@
<div role="note" aria-label="source link"> <div role="note" aria-label="source link">
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="_sources/index.rst.txt" <li><a href="_sources/stringtools.rst.txt"
rel="nofollow">Show Source</a></li> rel="nofollow">Show Source</a></li>
</ul> </ul>
</div> </div>
@ -650,7 +650,7 @@
</li> </li>
<li> <li>
<a href="#">stringtools documentation</a> &#187; <a href="index.html">stringtools documentation</a> &#187;
</li> </li>
<li class="nav-item nav-item-this"><a href="">stringtools package</a></li> <li class="nav-item nav-item-this"><a href="">stringtools package</a></li>