rebuilt html docs for version 0.1.31 from branch main with sphinx at 4…

…543cf1

0.1.31/api/cli.html

@@ -106,7 +106,7 @@
 <p>The toplevel command line interface.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="mdacli.cli.cli">
-<span class="sig-prename descclassname"><span class="pre">mdacli.cli.</span></span><span class="sig-name descname"><span class="pre">cli</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_class=&lt;Mock</span> <span class="pre">name='mock.AnalysisBase'</span> <span class="pre">id='140423703360128'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version=''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description=''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_modules=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_warnings=False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdacli/cli.html#cli"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdacli.cli.cli" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">mdacli.cli.</span></span><span class="sig-name descname"><span class="pre">cli</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_class=&lt;Mock</span> <span class="pre">name='mock.AnalysisBase'</span> <span class="pre">id='139831459525248'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version=''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description=''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_modules=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_warnings=False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdacli/cli.html#cli"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdacli.cli.cli" title="Link to this definition"></a></dt>
 <dd><p>Create the command-line interface.</p>
 <p>This function creates a command line interface with a given <cite>name</cite> based
 on a module list.</p>

0.1.31/api/logger.html

@@ -66,6 +66,7 @@
 <li class="toctree-l2"><a class="reference internal" href="save.html">Results Saving</a></li>
 <li class="toctree-l2"><a class="reference internal" href="colors.html">Coloring</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Logging</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#mdacli.logger.check_suffix"><code class="docutils literal notranslate"><span class="pre">check_suffix()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#mdacli.logger.setup_logging"><code class="docutils literal notranslate"><span class="pre">setup_logging()</span></code></a></li>
 </ul>
 </li>
@@ -104,19 +105,38 @@
   <section id="module-mdacli.logger">
 <span id="logging"></span><h1>Logging<a class="headerlink" href="#module-mdacli.logger" title="Link to this heading"></a></h1>
 <p>Logging.</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="mdacli.logger.check_suffix">
+<span class="sig-prename descclassname"><span class="pre">mdacli.logger.</span></span><span class="sig-name descname"><span class="pre">check_suffix</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"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">suffix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a></span></span><a class="reference internal" href="../_modules/mdacli/logger.html#check_suffix"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdacli.logger.check_suffix" title="Link to this definition"></a></dt>
+<dd><p>Check the suffix of a file name and adds if it not existing.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">filename</span></code> does not end with <code class="docutils literal notranslate"><span class="pre">suffix</span></code> the <code class="docutils literal notranslate"><span class="pre">suffix</span></code> is added and a
+warning will be issued.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>filename</strong> (<em>Name of the file to be checked.</em>)</p></li>
+<li><p><strong>suffix</strong> (Expected file suffix i.e. <code class="docutils literal notranslate"><span class="pre">.txt</span></code>.)</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><em>Checked and probably extended file name.</em></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="mdacli.logger.setup_logging">
-<span class="sig-prename descclassname"><span class="pre">mdacli.logger.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logobj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logfile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdacli/logger.html#setup_logging"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdacli.logger.setup_logging" title="Link to this definition"></a></dt>
-<dd><p>Create a logging environment for a given logobj.</p>
+<span class="sig-prename descclassname"><span class="pre">mdacli.logger.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logobj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.Logger" title="(in Python v3.12)"><span class="pre">Logger</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">logfile</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.12)"><span class="pre">Path</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">30</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdacli/logger.html#setup_logging"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdacli.logger.setup_logging" title="Link to this definition"></a></dt>
+<dd><p>Create a logging environment for a given <code class="docutils literal notranslate"><span class="pre">log_obj</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>logobj</strong> (<code class="docutils literal notranslate"><span class="pre">logging.Logger</span></code>) – A logging instance</p></li>
 <li><p><strong>logfile</strong> (<em>str</em>) – Name of the log file</p></li>
 <li><p><strong>level</strong> (<em>int</em>) – Set the root logger level to the specified level. If for example set
 to <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.DEBUG" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.DEBUG</span></code></a> detailed debug logs inludcing filename and
-function name are displayed. For :py:obj:<a href="#id1"><span class="problematic" id="id2">`</span></a>logging.INFO only the message
-logged from errors, warnings and infos will be displayed.</p></li>
+function name are displayed. For <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.INFO" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.INFO</span></code></a> only the
+message logged from errors, warnings and infos will be displayed.</p></li>
 </ul>
 </dd>
 </dl>

0.1.31/changelog.html

@@ -125,6 +125,9 @@
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading"></a></h1>
+<ul class="simple">
+<li><p>Cleanup logger function</p></li>
+</ul>
 <section id="v0-1-31-2024-07-08">
 <h2>v0.1.31 (2024-07-08)<a class="headerlink" href="#v0-1-31-2024-07-08" title="Link to this heading"></a></h2>
 <ul class="simple">

0.1.31/genindex.html

@@ -139,6 +139,8 @@ <h2 id="B">B</h2>
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/logger.html#mdacli.logger.check_suffix">check_suffix() (in module mdacli.logger)</a>
+</li>
       <li><a href="api/cli.html#mdacli.cli.cli">cli() (in module mdacli.cli)</a>
 </li>
       <li><a href="api/libcli.html#mdacli.libcli.convert_analysis_parameters">convert_analysis_parameters() (in module mdacli.libcli)</a>