Update documentation

ApeWorX · Nov 2, 2024 · 6a1057f · 6a1057f
1 parent bad8ea7
commit 6a1057f
Show file tree

Hide file tree

Showing 90 changed files with 9,472 additions and 6 deletions.
diff --git a/index.html b/index.html
@@ -2,4 +2,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>
-<meta http-equiv="refresh" content="0; URL=./latest/userguides/quickstart.html">
+<meta http-equiv="refresh" content="0; URL=./stable/userguides/quickstart.html">
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/main.doctree b/latest/.doctrees/methoddocs/main.doctree
diff --git a/latest/.doctrees/methoddocs/middlewares.doctree b/latest/.doctrees/methoddocs/middlewares.doctree
diff --git a/latest/.doctrees/methoddocs/runner.doctree b/latest/.doctrees/methoddocs/runner.doctree
diff --git a/latest/.doctrees/methoddocs/subscriptions.doctree b/latest/.doctrees/methoddocs/subscriptions.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/commands/cluster.doctree b/stable/.doctrees/commands/cluster.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/main.doctree b/stable/.doctrees/methoddocs/main.doctree
diff --git a/stable/.doctrees/methoddocs/middlewares.doctree b/stable/.doctrees/methoddocs/middlewares.doctree
diff --git a/stable/.doctrees/methoddocs/runner.doctree b/stable/.doctrees/methoddocs/runner.doctree
diff --git a/stable/.doctrees/methoddocs/subscriptions.doctree b/stable/.doctrees/methoddocs/subscriptions.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/managing.doctree b/stable/.doctrees/userguides/managing.doctree
diff --git a/stable/_sources/userguides/managing.md.txt b/stable/_sources/userguides/managing.md.txt
@@ -16,7 +16,7 @@ logging in to the Platform using [`silverback login`][silverback-login].
 
 A Workspace is an area for one or more people to co-manage a set of clusters together. You can manage workspaces from the Silverback CLI using [`silverback cluster workspaces`][silverback-cluster-workspaces].
 
-Using the Silverback CLI you can [list workspaces][silverback-cluster-workspaces-list], [make new ones][silverback-cluster-workspaces-new], [view their configuration information][silverback-cluster-workspaces-info], [update their metadata][silverback-cluster-workspaces-update], as well as [delete them][silverback-cluster-workspaces-delete] workspaces.
+Using the Silverback CLI you can [list workspaces][silverback-cluster-workspaces-list], [make new ones][silverback-cluster-workspaces-new], [view their configuration information][silverback-cluster-workspaces-info], [update their metadata][silverback-cluster-workspaces-update], as well as [delete them][silverback-cluster-workspaces-delete].
 
 ## Managing a Cluster
 

diff --git a/stable/commands/cluster.html b/stable/commands/cluster.html
@@ -339,13 +339,13 @@ <h3>new<a class="headerlink" href="#silverback-cluster-workspaces-new" title="Li
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-new-n">
 <span id="cmdoption-silverback-cluster-workspaces-new-name"></span><span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--name</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;workspace_name&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-new-n" title="Link to this definition"></a></dt>
-<dd><p><strong>Required</strong> Name for new workspace</p>
+<dd><p>Name for new workspace</p>
 </dd></dl>
 
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-silverback-cluster-workspaces-new-s">
 <span id="cmdoption-silverback-cluster-workspaces-new-slug"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--slug</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;workspace_slug&gt;</span></span><a class="headerlink" href="#cmdoption-silverback-cluster-workspaces-new-s" title="Link to this definition"></a></dt>
-<dd><p><strong>Required</strong> Slug for new workspace</p>
+<dd><p>Slug for new workspace</p>
 </dd></dl>
 
 <dl class="std option">

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -718,6 +718,8 @@ <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/exceptions.html#silverback.exceptions.CircuitBreaker">CircuitBreaker</a>
+</li>
+      <li><a href="methoddocs/exceptions.html#silverback.exceptions.ClientError">ClientError</a>
 </li>
       <li>
     CLUSTER

diff --git a/stable/methoddocs/exceptions.html b/stable/methoddocs/exceptions.html
@@ -90,6 +90,7 @@
     </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.exceptions.CircuitBreaker"><code class="docutils literal notranslate"><span class="pre">CircuitBreaker</span></code></a></li>
+<li><a class="reference internal" href="#silverback.exceptions.ClientError"><code class="docutils literal notranslate"><span class="pre">ClientError</span></code></a></li>
 <li><a class="reference internal" href="#silverback.exceptions.ContainerTypeMismatchError"><code class="docutils literal notranslate"><span class="pre">ContainerTypeMismatchError</span></code></a></li>
 <li><a class="reference internal" href="#silverback.exceptions.Halt"><code class="docutils literal notranslate"><span class="pre">Halt</span></code></a></li>
 <li><a class="reference internal" href="#silverback.exceptions.ImportFromStringError"><code class="docutils literal notranslate"><span class="pre">ImportFromStringError</span></code></a></li>
@@ -136,6 +137,13 @@
 <p>Custom exception (created by user) that will trigger an bot shutdown.</p>
 </dd></dl>
 
+<dl class="py exception">
+<dt class="sig sig-object py" id="silverback.exceptions.ClientError">
+<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">ClientError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Context</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.ClientError" 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>, <code class="xref py py-class docutils literal notranslate"><span class="pre">UsageError</span></code></p>
+<p>Exception for client errors in the HTTP request.</p>
+</dd></dl>
+
 <dl class="py exception">
 <dt class="sig sig-object py" id="silverback.exceptions.ContainerTypeMismatchError">
 <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">ContainerTypeMismatchError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TaskType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.ContainerTypeMismatchError" title="Link to this definition"></a></dt>

diff --git a/stable/objects.inv b/stable/objects.inv
diff --git a/stable/searchindex.js b/stable/searchindex.js
diff --git a/stable/userguides/managing.html b/stable/userguides/managing.html
@@ -137,7 +137,7 @@ <h1>Silverback Platform<a class="headerlink" href="#silverback-platform" title="
 <section id="managing-a-workspace">
 <h2>Managing a Workspace<a class="headerlink" href="#managing-a-workspace" title="Link to this heading"></a></h2>
 <p>A Workspace is an area for one or more people to co-manage a set of clusters together. You can manage workspaces from the Silverback CLI using <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces"><code class="docutils literal notranslate"><span class="pre">silverback</span> <span class="pre">cluster</span> <span class="pre">workspaces</span></code></a>.</p>
-<p>Using the Silverback CLI you can <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-list">list workspaces</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-new">make new ones</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-info">view their configuration information</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-update">update their metadata</a>, as well as <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-delete">delete them</a> workspaces.</p>
+<p>Using the Silverback CLI you can <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-list">list workspaces</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-new">make new ones</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-info">view their configuration information</a>, <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-update">update their metadata</a>, as well as <a class="reference external" href="../commands/cluster.html#silverback-cluster-workspaces-delete">delete them</a>.</p>
 </section>
 <section id="managing-a-cluster">
 <h2>Managing a Cluster<a class="headerlink" href="#managing-a-cluster" title="Link to this heading"></a></h2>

diff --git a/v0.6.4/.buildinfo b/v0.6.4/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b46fa637138fb600b9e344a8377fd2af
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.6.4/.doctrees/commands/cluster.doctree b/v0.6.4/.doctrees/commands/cluster.doctree
diff --git a/v0.6.4/.doctrees/commands/run.doctree b/v0.6.4/.doctrees/commands/run.doctree
diff --git a/v0.6.4/.doctrees/environment.pickle b/v0.6.4/.doctrees/environment.pickle
diff --git a/v0.6.4/.doctrees/index.doctree b/v0.6.4/.doctrees/index.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/exceptions.doctree b/v0.6.4/.doctrees/methoddocs/exceptions.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/main.doctree b/v0.6.4/.doctrees/methoddocs/main.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/middlewares.doctree b/v0.6.4/.doctrees/methoddocs/middlewares.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/runner.doctree b/v0.6.4/.doctrees/methoddocs/runner.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/subscriptions.doctree b/v0.6.4/.doctrees/methoddocs/subscriptions.doctree
diff --git a/v0.6.4/.doctrees/methoddocs/utils.doctree b/v0.6.4/.doctrees/methoddocs/utils.doctree
diff --git a/v0.6.4/.doctrees/userguides/deploying.doctree b/v0.6.4/.doctrees/userguides/deploying.doctree
diff --git a/v0.6.4/.doctrees/userguides/development.doctree b/v0.6.4/.doctrees/userguides/development.doctree
diff --git a/v0.6.4/.doctrees/userguides/managing.doctree b/v0.6.4/.doctrees/userguides/managing.doctree
diff --git a/v0.6.4/.doctrees/userguides/quickstart.doctree b/v0.6.4/.doctrees/userguides/quickstart.doctree
diff --git a/v0.6.4/_sources/commands/cluster.rst.txt b/v0.6.4/_sources/commands/cluster.rst.txt
@@ -0,0 +1,37 @@
+Cloud Platform
+==============
+CLI commands for interacting with the Silverback Platform.
+
+.. click:: silverback._cli:login
+    :prog: silverback login
+    :nested: none
+
+.. click:: silverback._cli:cluster
+    :prog: silverback cluster
+    :nested: full
+    :commands: new, update, list, info, health
+
+.. click:: silverback._cli:workspaces
+    :prog: silverback cluster workspaces
+    :nested: full
+    :commands: new, list, info, update, delete
+
+.. click:: silverback._cli:vars
+    :prog: silverback cluster vars
+    :nested: full
+    :commands: new, list, info, update, remove
+
+.. click:: silverback._cli:registry_auth
+    :prog: silverback cluster registry auth
+    :nested: full
+    :commands: new, list, info, update, remove
+
+.. click:: silverback._cli:bots
+    :prog: silverback cluster bots
+    :nested: full
+    :commands: new, list, info, update, remove, health, start, stop, logs, errors
+
+.. click:: silverback._cli:pay
+    :prog: silverback cluster pay
+    :nested: full
+    :commands: create, add-time, cancel
diff --git a/v0.6.4/_sources/commands/run.rst.txt b/v0.6.4/_sources/commands/run.rst.txt
@@ -0,0 +1,11 @@
+Local Development
+=================
+CLI commands for local development of running Silverback bots and task workers.
+
+.. click:: silverback._cli:run
+  :prog: silverback run
+  :nested: none
+
+.. click:: silverback._cli:worker
+  :prog: silverback worker
+  :nested: none
diff --git a/v0.6.4/_sources/index.rst.txt b/v0.6.4/_sources/index.rst.txt
@@ -0,0 +1,9 @@
+.. dynamic-toc-tree::
+    :userguides:
+        - quickstart
+        - development
+        - managing
+        - deploying
+    :commands:
+        - run
+        - cluster
diff --git a/v0.6.4/_sources/methoddocs/exceptions.md.txt b/v0.6.4/_sources/methoddocs/exceptions.md.txt
@@ -0,0 +1,7 @@
+# silverback.exceptions
+
+```{eval-rst}
+.. automodule:: silverback.exceptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.4/_sources/methoddocs/main.md.txt b/v0.6.4/_sources/methoddocs/main.md.txt
@@ -0,0 +1,10 @@
+# silverback.main
+
+The `silverback.main` module contains the high-level implementation of the the user's
+Silverback application, meant to be used to expose method handlers and other functionality.
+
+```{eval-rst}
+.. automodule:: silverback.main
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.4/_sources/methoddocs/middlewares.md.txt b/v0.6.4/_sources/methoddocs/middlewares.md.txt
@@ -0,0 +1,10 @@
+# silverback.middlewares
+
+The `silverback.middlewares` module contains middleware intended to improve the usability of
+silverback as a whole, and add integrations for the silverback platform as well.
+
+```{eval-rst}
+.. automodule:: silverback.middlewares
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.4/_sources/methoddocs/runner.md.txt b/v0.6.4/_sources/methoddocs/runner.md.txt
@@ -0,0 +1,10 @@
+# silverback.runner
+
+The `silverback.runner` module contains implementations for running Silverback apps in a variety
+of different scenarios and trigger methods.
+
+```{eval-rst}
+.. automodule:: silverback.runner
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.4/_sources/methoddocs/subscriptions.md.txt b/v0.6.4/_sources/methoddocs/subscriptions.md.txt
@@ -0,0 +1,10 @@
+# silverback.subscriptions
+
+The `silverback.subscriptions` module contains an implementation of a Websocket subscription queue,
+used for connected to an RPC node via websockets that implements the `eth_subscribe` RPC method.
+
+```{eval-rst}
+.. automodule:: silverback.subscriptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.4/_sources/methoddocs/utils.md.txt b/v0.6.4/_sources/methoddocs/utils.md.txt
@@ -0,0 +1,7 @@
+# silverback.utils
+
+```{eval-rst}
+.. automodule:: silverback.utils
+    :members:
+    :show-inheritance:
+```