Improved documentation for cpl.application

This commit is contained in:
2021-04-14 22:20:18 +02:00
parent ed1a4eb88c
commit 4209055d62
97 changed files with 429 additions and 4987 deletions

View File

@@ -93,11 +93,11 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.dependency_injection.html">cpl.dependency_injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl.environment.html">cpl.environment</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.logging</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_abc">cpl.logging.logger_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_service">cpl.logging.logger_service module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings">cpl.logging.logging_settings module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_abc">cpl.logging.logger_abc</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logger_service">cpl.logging.logger_service</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_level_enum">cpl.logging.logging_level_enum</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings">cpl.logging.logging_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.logging.logging_settings_name_enum">cpl.logging.logging_settings_name_enum</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
@@ -106,7 +106,6 @@
<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CPL_CLI</a></li>
</ul>
@@ -179,7 +178,7 @@
<div class="section" id="cpl-logging">
<h1>cpl.logging<a class="headerlink" href="#cpl-logging" title="Permalink to this headline"></a></h1>
<div class="section" id="module-cpl.logging.logger_abc">
<span id="cpl-logging-logger-abc-module"></span><h2>cpl.logging.logger_abc module<a class="headerlink" href="#module-cpl.logging.logger_abc" title="Permalink to this headline"></a></h2>
<span id="cpl-logging-logger-abc"></span><h2>cpl.logging.logger_abc<a class="headerlink" href="#module-cpl.logging.logger_abc" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl.logging.logger_abc.LoggerABC">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_abc.</span></code><code class="sig-name descname"><span class="pre">LoggerABC</span></code><a class="headerlink" href="#cpl.logging.logger_abc.LoggerABC" title="Permalink to this definition"></a></dt>
@@ -252,7 +251,7 @@
</div>
<div class="section" id="module-cpl.logging.logger_service">
<span id="cpl-logging-logger-service-module"></span><h2>cpl.logging.logger_service module<a class="headerlink" href="#module-cpl.logging.logger_service" title="Permalink to this headline"></a></h2>
<span id="cpl-logging-logger-service"></span><h2>cpl.logging.logger_service<a class="headerlink" href="#module-cpl.logging.logger_service" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl.logging.logger_service.Logger">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logger_service.</span></code><code class="sig-name descname"><span class="pre">Logger</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">logging_settings</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.logging.logging_settings.LoggingSettings" title="cpl.logging.logging_settings.LoggingSettings"><span class="pre">cpl.logging.logging_settings.LoggingSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_format</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.time.html#cpl.time.time_format_settings.TimeFormatSettings" title="cpl.time.time_format_settings.TimeFormatSettings"><span class="pre">cpl.time.time_format_settings.TimeFormatSettings</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="cpl.environment.html#cpl.environment.application_environment_abc.ApplicationEnvironmentABC" title="cpl.environment.application_environment_abc.ApplicationEnvironmentABC"><span class="pre">cpl.environment.application_environment_abc.ApplicationEnvironmentABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logger_service.Logger" title="Permalink to this definition"></a></dt>
@@ -332,7 +331,7 @@
</div>
<div class="section" id="module-cpl.logging.logging_level_enum">
<span id="cpl-logging-logging-level-enum-module"></span><h2>cpl.logging.logging_level_enum module<a class="headerlink" href="#module-cpl.logging.logging_level_enum" title="Permalink to this headline"></a></h2>
<span id="cpl-logging-logging-level-enum"></span><h2>cpl.logging.logging_level_enum<a class="headerlink" href="#module-cpl.logging.logging_level_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl.logging.logging_level_enum.LoggingLevelEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_level_enum.</span></code><code class="sig-name descname"><span class="pre">LoggingLevelEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logging_level_enum.LoggingLevelEnum" title="Permalink to this definition"></a></dt>
@@ -377,7 +376,7 @@
</div>
<div class="section" id="module-cpl.logging.logging_settings">
<span id="cpl-logging-logging-settings-module"></span><h2>cpl.logging.logging_settings module<a class="headerlink" href="#module-cpl.logging.logging_settings" title="Permalink to this headline"></a></h2>
<span id="cpl-logging-logging-settings"></span><h2>cpl.logging.logging_settings<a class="headerlink" href="#module-cpl.logging.logging_settings" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl.logging.logging_settings.LoggingSettings">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_settings.</span></code><code class="sig-name descname"><span class="pre">LoggingSettings</span></code><a class="headerlink" href="#cpl.logging.logging_settings.LoggingSettings" title="Permalink to this definition"></a></dt>
@@ -414,7 +413,7 @@
</div>
<div class="section" id="module-cpl.logging.logging_settings_name_enum">
<span id="cpl-logging-logging-settings-name-enum-module"></span><h2>cpl.logging.logging_settings_name_enum module<a class="headerlink" href="#module-cpl.logging.logging_settings_name_enum" title="Permalink to this headline"></a></h2>
<span id="cpl-logging-logging-settings-name-enum"></span><h2>cpl.logging.logging_settings_name_enum<a class="headerlink" href="#module-cpl.logging.logging_settings_name_enum" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.logging.logging_settings_name_enum.</span></code><code class="sig-name descname"><span class="pre">LoggingSettingsNameEnum</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum" title="Permalink to this definition"></a></dt>