Updated docs

This commit is contained in:
2023-04-04 13:16:19 +02:00
parent b2efe285a9
commit 119052f9a2
71 changed files with 363 additions and 487 deletions

View File

@@ -4,7 +4,7 @@
<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_discord package &mdash; Common Python Library documentation</title>
<title>Discord Reference &mdash; Common Python Library documentation</title>
<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]>
@@ -44,23 +44,15 @@
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">cpl_discord package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper package</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Discord Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.command.html">cpl_discord.command package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.configuration.html">cpl_discord.configuration package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.container.html">cpl_discord.container package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.events.html">cpl_discord.events package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.helper.html">cpl_discord.helper package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_discord.service.html">cpl_discord.service package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_discord.discord_event_types_enum">cpl_discord.discord_event_types_enum module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-cpl_discord">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#cpl-discord-cpl-discord">cpl-discord CPL Discord</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query reference</a></li>
@@ -81,7 +73,7 @@
<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_discord package</li>
<li>Discord Reference</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_discord.rst.txt" rel="nofollow"> View page source</a>
</li>
@@ -91,10 +83,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="cpl-discord-package">
<h1>cpl_discord package<a class="headerlink" href="#cpl-discord-package" title="Permalink to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this heading"></a></h2>
<section id="discord-reference">
<h1>Discord Reference<a class="headerlink" href="#discord-reference" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.application.html">cpl_discord.application package</a><ul>
@@ -226,10 +216,6 @@
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-cpl_discord.discord_event_types_enum">
<span id="cpl-discord-discord-event-types-enum-module"></span><h2>cpl_discord.discord_event_types_enum module<a class="headerlink" href="#module-cpl_discord.discord_event_types_enum" title="Permalink to this heading"></a></h2>
<dl class="py class">
@@ -494,62 +480,6 @@
</dd></dl>
</section>
<section id="module-cpl_discord">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_discord" title="Permalink to this heading"></a></h2>
<section id="cpl-discord-cpl-discord">
<h3>cpl-discord CPL Discord<a class="headerlink" href="#cpl-discord-cpl-discord" title="Permalink to this heading"></a></h3>
<p>Link between discord.py and CPL</p>
<dl class="field-list simple">
<dt class="field-odd">copyright</dt>
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2022 - 2023 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 class="sig sig-object py" id="cpl_discord.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_discord.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><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_discord.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 class="sig sig-object py" id="cpl_discord.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_discord.VersionInfo.major" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 0</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_discord.VersionInfo.micro" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 2</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="cpl_discord.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_discord.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cpl_discord.add_discord">
<span class="sig-prename descclassname"><span class="pre">cpl_discord.</span></span><span class="sig-name descname"><span class="pre">add_discord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.add_discord" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cpl_discord.get_discord_collection">
<span class="sig-prename descclassname"><span class="pre">cpl_discord.</span></span><span class="sig-name descname"><span class="pre">get_discord_collection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC" title="cpl_core.dependency_injection.service_collection_abc.ServiceCollectionABC"><span class="pre">ServiceCollectionABC</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 internal" href="cpl_discord.service.html#cpl_discord.service.discord_collection_abc.DiscordCollectionABC" title="cpl_discord.service.discord_collection_abc.DiscordCollectionABC"><span class="pre">DiscordCollectionABC</span></a></span></span><a class="headerlink" href="#cpl_discord.get_discord_collection" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="cpl_discord.init">
<span class="sig-prename descclassname"><span class="pre">cpl_discord.</span></span><span class="sig-name descname"><span class="pre">init</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_discord.init" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
</section>
</section>