Build docs and added tutorial files

This commit is contained in:
2022-06-27 21:42:34 +02:00
parent b9e0b7ccd0
commit 4083ac0c14
196 changed files with 6064 additions and 10979 deletions

View File

@@ -1,68 +1,33 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl &mdash; Common Python Library documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Common Python Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
@@ -70,18 +35,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
@@ -90,73 +44,32 @@
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>cpl</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/modules.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="cpl">
<h1>cpl<a class="headerlink" href="#cpl" title="Permalink to this headline"></a></h1>
<section id="cpl">
<h1>cpl<a class="headerlink" href="#cpl" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a><ul>
@@ -180,6 +93,17 @@
<li class="toctree-l3"><a class="reference internal" href="setup.html#what-s-next">Whats next</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-application.html">Extend application</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.create-startup.html">Create startup class</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.extend-startup.html">Extend startup</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.appsettings.html">Using appsettings.json</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.console-arguments.html">Handle console arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.console.html">Use cpl_core.console.Console</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.logging.html">Use builtin logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorials.mail.html">Send mails</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul>
@@ -198,6 +122,7 @@
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.add.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a><ul>
@@ -221,12 +146,14 @@
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.install.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#project-types">Project types</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.new.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a><ul>
@@ -238,6 +165,7 @@
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.remove.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
@@ -245,9 +173,13 @@
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#contents">Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#arguments">Arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli.uninstall.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli.update.html#flags">Flags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
</ul>
</li>
@@ -264,7 +196,7 @@
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_abc">cpl_core.configuration.configuration_abc</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_model_abc">cpl_core.configuration.configuration_model_abc</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.configuration_variable_name_enum">cpl_core.configuration.configuration_variable_name_enum</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#module-cpl_core.configuration.console_argument">cpl_core.configuration.console_argument</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.configuration.html#cpl-core-configuration-console-argument">cpl_core.configuration.console_argument</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.console.html">cpl_core.console</a><ul>
@@ -323,6 +255,22 @@
<li class="toctree-l3"><a class="reference internal" href="cpl_core.mailing.html#module-cpl_core.mailing.email_client_settings_name_enum">cpl_core.mailing.email_client_settings_name_enum</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.pipes.html">cpl_core.pipes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.bool_pipe">cpl_core.pipes.bool_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_char_to_lower_pipe">cpl_core.pipes.first_char_to_lower_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.first_to_upper_pipe">cpl_core.pipes.first_to_upper_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.ip_address_pipe">cpl_core.pipes.ip_address_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.pipe_abc">cpl_core.pipes.pipe_abc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_camel_case_pipe">cpl_core.pipes.to_camel_case_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.to_snake_case_pipe">cpl_core.pipes.to_snake_case_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes.version_pipe">cpl_core.pipes.version_pipe module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.pipes.html#module-cpl_core.pipes">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="cpl_core.pipes.html#cpl-core-sh-edraft-common-python-library">cpl-core sh-edraft Common Python library</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_core.time.html">cpl_core.time</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings">cpl_core.time.time_format_settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_core.time.html#module-cpl_core.time.time_format_settings_names_enum">cpl_core.time.time_format_settings_names_enum</a></li>
@@ -353,50 +301,34 @@
</li>
</ul>
</div>
</div>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, Sven Heidemann.
</p>
<p>&#169; Copyright 2021, Sven Heidemann.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>