Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 28, 2025
1 parent ab5c237 commit 0a3626c
Show file tree
Hide file tree
Showing 13 changed files with 6 additions and 18 deletions.
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/main.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/middlewares.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/runner.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/subscriptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
2 changes: 0 additions & 2 deletions latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1569,8 +1569,6 @@ <h2 id="S">S</h2>
<li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware">SilverbackMiddleware (class in silverback.middlewares)</a>
</li>
<li><a href="methoddocs/exceptions.html#silverback.exceptions.StartupFailure">StartupFailure</a>
</li>
<li><a href="methoddocs/subscriptions.html#silverback.subscriptions.SubscriptionType">SubscriptionType (class in silverback.subscriptions)</a>
</li>
<li><a href="methoddocs/main.html#silverback.main.SystemConfig">SystemConfig (class in silverback.main)</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion latest/methoddocs/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@

<dl class="py exception">
<dt class="sig sig-object py" id="silverback.exceptions.StartupFailure">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">StartupFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exceptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Exception</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.StartupFailure" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">StartupFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exceptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BaseException</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.StartupFailure" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#silverback.exceptions.SilverbackException" title="silverback.exceptions.SilverbackException"><code class="xref py py-class docutils literal notranslate"><span class="pre">SilverbackException</span></code></a></p>
</dd></dl>

Expand Down
4 changes: 2 additions & 2 deletions latest/methoddocs/runner.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h1>silverback.runner<a class="headerlink" href="#silverback-runner" title="Link
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="silverback.runner.BaseRunner.run">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#silverback.runner.BaseRunner.run" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">runtime_tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Task</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Task</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.runner.BaseRunner.run" title="Link to this definition"></a></dt>
<dd><p>Run the task broker client for the assembled <code class="docutils literal notranslate"><span class="pre">SilverbackBot</span></code> bot.</p>
<p>Will listen for events against the connected provider (using <cite>ManagerAccessMixin</cite> context),
and process them by kicking events over to the configured broker.</p>
Expand Down Expand Up @@ -167,7 +167,7 @@ <h1>silverback.runner<a class="headerlink" href="#silverback-runner" title="Link
<p>Run a single bot against a live network using a basic in-memory queue and websockets.</p>
<dl class="py method">
<dt class="sig sig-object py" id="silverback.runner.WebsocketRunner.run">
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#silverback.runner.WebsocketRunner.run" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">runtime_tasks</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Task</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Task</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.runner.WebsocketRunner.run" title="Link to this definition"></a></dt>
<dd><p>Run the task broker client for the assembled <code class="docutils literal notranslate"><span class="pre">SilverbackBot</span></code> bot.</p>
<p>Will listen for events against the connected provider (using <cite>ManagerAccessMixin</cite> context),
and process them by kicking events over to the configured broker.</p>
Expand Down
14 changes: 2 additions & 12 deletions latest/methoddocs/subscriptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,7 @@
<button class="rside-close js-menu xl:hidden" aria-label="Close Table of Contents" type="button" aria-controls="rside" aria-expanded="false">
<i class="i-lucide close"></i>
</button>
<div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><div class="localtoc"><h3>On this page</h3><ul>
<li><a class="reference internal" href="#silverback.subscriptions.SubscriptionType"><code class="docutils literal notranslate"><span class="pre">SubscriptionType</span></code></a></li>
</ul>
</div><div id="ethical-ad-placement" data-ea-publisher="readthedocs"></div></div>
<div class="sy-scrollbar sy-rside-inner px-6 xl:top-16 xl:sticky xl:pl-0 pt-6 pb-4"><div id="ethical-ad-placement" data-ea-publisher="readthedocs"></div></div>
</aside>
<div class="rside-overlay js-menu" role="button" aria-label="Close Table of Contents" aria-controls="rside" aria-expanded="false"></div>
<main class="sy-main w-full max-sm:max-w-full print:pt-6"><div class="sy-breadcrumbs" role="navigation">
Expand Down Expand Up @@ -123,14 +120,7 @@
<h1>silverback.subscriptions<a class="headerlink" href="#silverback-subscriptions" title="Link to this heading"></a></h1>
<p>The <code class="docutils literal notranslate"><span class="pre">silverback.subscriptions</span></code> module contains an implementation of a Websocket subscription queue,
used for connected to an RPC node via websockets that implements the <code class="docutils literal notranslate"><span class="pre">eth_subscribe</span></code> RPC method.</p>
<dl class="py class" id="module-silverback.subscriptions">
<dt class="sig sig-object py" id="silverback.subscriptions.SubscriptionType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.subscriptions.</span></span><span class="sig-name descname"><span class="pre">SubscriptionType</span></span><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="#silverback.subscriptions.SubscriptionType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<p>An enumeration.</p>
</dd></dl>

</section>
<span class="target" id="module-silverback.subscriptions"></span></section>

</article><button class="back-to-top" type="button">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
Expand Down
Binary file modified latest/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 0a3626c

Please sign in to comment.