Added docs for cpl.configuration

docs/build/html/_sources/cpl.rst.txt

@@ -15,10 +15,3 @@ CPL
     cpl.time
     cpl.utils
 
-Module contents
----------------
-
-.. automodule:: cpl
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/build/html/cpl.application.html

@@ -102,7 +102,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>
@@ -243,7 +242,7 @@
 <dd><p>Sets the custom startup class to use</p>
 <blockquote>
 <div><dl class="simple">
-<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Type of <a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
+<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
 </dd>
 </dl>
 </div></blockquote>
@@ -274,7 +273,7 @@
 <dd><p>Sets the custom startup class to use</p>
 <blockquote>
 <div><dl class="simple">
-<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Type of <a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a></p>
+<dt>startup: Type[<a class="reference internal" href="#cpl.application.startup_abc.StartupABC" title="cpl.application.startup_abc.StartupABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.application.startup_abc.StartupABC</span></code></a>]</dt><dd><p>Startup class to use</p>
 </dd>
 </dl>
 </div></blockquote>

docs/build/html/cpl.configuration.html

@@ -103,7 +103,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>
@@ -186,45 +185,53 @@
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.add_configuration">
 <code class="sig-name descname"><span class="pre">add_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_configuration" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add configuration object
-:param key_type:
-:param value:
-:return:</p>
+<dd><p>Add configuration object</p>
+<blockquote>
+<div><p>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]
+value: <a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.add_console_argument">
 <code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_console_argument" title="Permalink to this definition">¶</a></dt>
-<dd><p>Adds console argument to known console arguments
-:param argument:
-:return:</p>
+<dd><p>Adds console argument to known console arguments</p>
+<blockquote>
+<div><p>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.console_argument.ConsoleArgument</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.add_console_arguments">
 <code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_console_arguments" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads the console arguments
-:param error: defines is invalid argument error will be shown or not
-:return:</p>
+<dd><p>Reads the console arguments</p>
+<blockquote>
+<div><dl class="simple">
+<dt>error: <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></dt><dd><p>Defines is invalid argument error will be shown or not</p>
+</dd>
+</dl>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.add_environment_variables">
 <code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_environment_variables" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads the environment variables
-:param prefix:
-:return:</p>
+<dd><p>Reads the environment variables</p>
+<blockquote>
+<div><p>prefix: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.add_json_file">
 <code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.add_json_file" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads and saves settings from given json file
-:param name:
-:param optional:
-:param output:
-:param path:
-:return:</p>
+<dd><p>Reads and saves settings from given json file</p>
+<blockquote>
+<div><p>name (str): Name of the file
+optional: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
+output: <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>
+path: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
@@ -245,9 +252,13 @@
 <dl class="py method">
 <dt id="cpl.configuration.configuration.Configuration.get_configuration">
 <code class="sig-name descname"><span class="pre">get_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.configuration.configuration.Configuration.get_configuration" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns value in configuration by given type
-:param search_type:
-:return:</p>
+<dd><p>Returns value from configuration by given type</p>
+<blockquote>
+<div><p>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p>
+</div></blockquote>
+<blockquote>
+<div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p>
+</div></blockquote>
 </dd></dl>
 
 </dd></dl>
@@ -261,46 +272,54 @@
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code></p>
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_configuration">
-<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition">¶</a></dt>
-<dd><p>Add configuration object
-:param key_type:
-:param value:
-:return:</p>
+<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_configuration" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add configuration object</p>
+<blockquote>
+<div><p>key_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>]
+value: <a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_console_argument">
 <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_argument</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">argument</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><a class="reference internal" href="#cpl.configuration.console_argument.ConsoleArgument" title="cpl.configuration.console_argument.ConsoleArgument"><span class="pre">cpl.configuration.console_argument.ConsoleArgument</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_console_argument" title="Permalink to this definition">¶</a></dt>
-<dd><p>Adds console argument to known console arguments
-:param argument:
-:return:</p>
+<dd><p>Adds console argument to known console arguments</p>
+<blockquote>
+<div><p>argument: <code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.console.console_argument.ConsoleArgument</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_console_arguments">
 <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_console_arguments</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_console_arguments" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads the console arguments
-:param error: defines is invalid argument error will be shown or not
-:return:</p>
+<dd><p>Reads the console arguments</p>
+<blockquote>
+<div><dl class="simple">
+<dt>error: <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></dt><dd><p>Defines is invalid argument error will be shown or not</p>
+</dd>
+</dl>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_environment_variables">
 <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_environment_variables</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_environment_variables" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads the environment variables
-:param prefix:
-:return:</p>
+<dd><p>Reads the environment variables</p>
+<blockquote>
+<div><p>prefix: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.add_json_file">
 <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">add_json_file</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></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">output</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.add_json_file" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads and saves settings from given json file
-:param name:
-:param optional:
-:param output:
-:param path:
-:return:</p>
+<dd><p>Reads and saves settings from given json file</p>
+<blockquote>
+<div><p>name (str): Name of the file
+optional: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>
+output: <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>
+path: <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
+</div></blockquote>
 </dd></dl>
 
 <dl class="py method">
@@ -321,9 +340,13 @@
 <dl class="py method">
 <dt id="cpl.configuration.configuration_abc.ConfigurationABC.get_configuration">
 <em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">get_configuration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">search_type</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">Type</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span> </span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl.configuration.configuration_abc.ConfigurationABC.get_configuration" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns value in configuration by given type
-:param search_type:
-:return:</p>
+<dd><p>Returns value from configuration by given type</p>
+<blockquote>
+<div><p>search_type: Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Type[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p>
+</div></blockquote>
+<blockquote>
+<div><p>Object of Union[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, Callable[<a class="reference internal" href="#cpl.configuration.configuration_model_abc.ConfigurationModelABC" title="cpl.configuration.configuration_model_abc.ConfigurationModelABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl.configuration.configuration_model_abc.ConfigurationModelABC</span></code></a>]]</p>
+</div></blockquote>
 </dd></dl>
 
 </dd></dl>

docs/build/html/cpl.console.html

@@ -103,7 +103,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.database.connection.html

@@ -108,7 +108,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.database.context.html

@@ -108,7 +108,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.database.html

@@ -104,7 +104,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.dependency_injection.html

@@ -104,7 +104,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.environment.html

@@ -101,7 +101,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.html

@@ -96,10 +96,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#module-cpl">Module contents</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#sh-cpl-sh-edraft-common-python-library">sh_cpl sh-edraft Common Python library</a></li>
-</ul>
-</li>
 </ul>
 </li>
 </ul>
@@ -257,47 +253,6 @@
 </li>
 </ul>
 </div>
-<div class="section" id="module-cpl">
-<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="sh-cpl-sh-edraft-common-python-library">
-<h3>sh_cpl sh-edraft Common Python library<a class="headerlink" href="#sh-cpl-sh-edraft-common-python-library" title="Permalink to this headline">¶</a></h3>
-<p>sh-edraft Common Python library</p>
-<dl class="field-list simple">
-<dt class="field-odd">copyright</dt>
-<dd class="field-odd"><ol class="loweralpha simple" start="3">
-<li><p>2020 - 2021 sh-edraft.de</p></li>
-</ol>
-</dd>
-<dt class="field-even">license</dt>
-<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
-</dd>
-</dl>
-<dl class="py class">
-<dt id="cpl.VersionInfo">
-<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl.</span></code><code class="sig-name descname"><span class="pre">VersionInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl.VersionInfo" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
-<dl class="py attribute">
-<dt id="cpl.VersionInfo.major">
-<code class="sig-name descname"><span class="pre">major</span></code><a class="headerlink" href="#cpl.VersionInfo.major" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 0</p>
-</dd></dl>
-
-<dl class="py attribute">
-<dt id="cpl.VersionInfo.micro">
-<code class="sig-name descname"><span class="pre">micro</span></code><a class="headerlink" href="#cpl.VersionInfo.micro" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 2</p>
-</dd></dl>
-
-<dl class="py attribute">
-<dt id="cpl.VersionInfo.minor">
-<code class="sig-name descname"><span class="pre">minor</span></code><a class="headerlink" href="#cpl.VersionInfo.minor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Alias for field number 1</p>
-</dd></dl>
-
-</dd></dl>
-
-</div>
-</div>
 </div>
 
 

docs/build/html/cpl.logging.html

@@ -103,7 +103,6 @@
 <li class="toctree-l2"><a class="reference internal" href="cpl.mailing.html">cpl.mailing</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.mailing.html

@@ -103,7 +103,6 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.time.html">cpl.time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.time.html

@@ -100,7 +100,6 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="cpl.utils.html">cpl.utils</a></li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/cpl.utils.html

@@ -100,7 +100,6 @@
 <li class="toctree-l3"><a class="reference internal" href="#module-cpl.utils.string">cpl.utils.string</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a></li>
 </ul>
 </li>
 </ul>

docs/build/html/genindex.html

@@ -390,13 +390,6 @@
       <li><a href="cpl.utils.html#cpl.utils.string.String.convert_to_snake_case">convert_to_snake_case() (cpl.utils.string.String static method)</a>
 </li>
       <li>
-    cpl
-
-      <ul>
-        <li><a href="cpl.html#module-cpl">module</a>
-</li>
-      </ul></li>
-      <li>
     cpl.application.application_abc
 
       <ul>
@@ -1050,19 +1043,11 @@
 </li>
       </ul></li>
       <li><a href="cpl.application.html#cpl.application.application_abc.ApplicationABC.main">main() (cpl.application.application_abc.ApplicationABC method)</a>
-</li>
-      <li><a href="cpl.html#cpl.VersionInfo.major">major (cpl.VersionInfo attribute)</a>
-</li>
-      <li><a href="cpl.html#cpl.VersionInfo.micro">micro (cpl.VersionInfo attribute)</a>
-</li>
-      <li><a href="cpl.html#cpl.VersionInfo.minor">minor (cpl.VersionInfo attribute)</a>
 </li>
       <li>
     module
 
       <ul>
-        <li><a href="cpl.html#module-cpl">cpl</a>
-</li>
         <li><a href="cpl.application.html#module-cpl.application.application_abc">cpl.application.application_abc</a>
 </li>
         <li><a href="cpl.application.html#module-cpl.application.application_builder">cpl.application.application_builder</a>
@@ -1389,10 +1374,6 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="cpl.configuration.html#cpl.configuration.console_argument.ConsoleArgument.value_token">value_token() (cpl.configuration.console_argument.ConsoleArgument property)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="cpl.html#cpl.VersionInfo">VersionInfo (class in cpl)</a>
 </li>
   </ul></td>
 </tr></table>

docs/build/html/modules.html

@@ -238,10 +238,6 @@
 <li class="toctree-l3"><a class="reference internal" href="cpl.utils.html#module-cpl.utils.string">cpl.utils.string</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="cpl.html#module-cpl">Module contents</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="cpl.html#sh-cpl-sh-edraft-common-python-library">sh_cpl sh-edraft Common Python library</a></li>
-</ul>
-</li>
 </ul>
 </li>
 </ul>

docs/build/html/py-modindex.html

@@ -165,7 +165,7 @@
        <td><img src="_static/minus.png" class="toggler"
               id="toggle-1" style="display: none" alt="-" /></td>
        <td>
-       <a href="cpl.html#module-cpl"><code class="xref">cpl</code></a></td><td>
+       <code class="xref">cpl</code></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

docs/source/cpl.rst

@@ -15,10 +15,3 @@ CPL
     cpl.time
     cpl.utils
 
-Module contents
----------------
-
-.. automodule:: cpl
-   :members:
-   :undoc-members:
-   :show-inheritance: