Update documentation

ApeWorX · Oct 23, 2024 · b7a8f72 · b7a8f72
1 parent 24c3b94
commit b7a8f72
Show file tree

Hide file tree

Showing 65 changed files with 5,933 additions and 1 deletion.
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/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/v0.6.2/.buildinfo b/v0.6.2/.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.2/.doctrees/commands/cluster.doctree b/v0.6.2/.doctrees/commands/cluster.doctree
diff --git a/v0.6.2/.doctrees/commands/run.doctree b/v0.6.2/.doctrees/commands/run.doctree
diff --git a/v0.6.2/.doctrees/environment.pickle b/v0.6.2/.doctrees/environment.pickle
diff --git a/v0.6.2/.doctrees/index.doctree b/v0.6.2/.doctrees/index.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/exceptions.doctree b/v0.6.2/.doctrees/methoddocs/exceptions.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/main.doctree b/v0.6.2/.doctrees/methoddocs/main.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/middlewares.doctree b/v0.6.2/.doctrees/methoddocs/middlewares.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/runner.doctree b/v0.6.2/.doctrees/methoddocs/runner.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/subscriptions.doctree b/v0.6.2/.doctrees/methoddocs/subscriptions.doctree
diff --git a/v0.6.2/.doctrees/methoddocs/utils.doctree b/v0.6.2/.doctrees/methoddocs/utils.doctree
diff --git a/v0.6.2/.doctrees/userguides/development.doctree b/v0.6.2/.doctrees/userguides/development.doctree
diff --git a/v0.6.2/.doctrees/userguides/platform.doctree b/v0.6.2/.doctrees/userguides/platform.doctree
diff --git a/v0.6.2/.doctrees/userguides/quickstart.doctree b/v0.6.2/.doctrees/userguides/quickstart.doctree
diff --git a/v0.6.2/_sources/commands/cluster.rst.txt b/v0.6.2/_sources/commands/cluster.rst.txt
@@ -0,0 +1,31 @@
+Cloud Platform
+==============
+
+.. click:: silverback._cli:login
+    :prog: silverback login
+    :nested: none
+
+.. click:: silverback._cli:cluster
+    :prog: silverback cluster
+    :nested: full
+    :commands: workspaces, new, list, info, health
+
+.. 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.2/_sources/commands/run.rst.txt b/v0.6.2/_sources/commands/run.rst.txt
@@ -0,0 +1,10 @@
+Local Development
+=================
+
+.. click:: silverback._cli:run
+  :prog: silverback run
+  :nested: none
+
+.. click:: silverback._cli:worker
+  :prog: silverback worker
+  :nested: none
diff --git a/v0.6.2/_sources/index.rst.txt b/v0.6.2/_sources/index.rst.txt
@@ -0,0 +1 @@
+.. dynamic-toc-tree::
diff --git a/v0.6.2/_sources/methoddocs/exceptions.md.txt b/v0.6.2/_sources/methoddocs/exceptions.md.txt
@@ -0,0 +1,7 @@
+# silverback.exceptions
+
+```{eval-rst}
+.. automodule:: silverback.exceptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.6.2/_sources/methoddocs/main.md.txt b/v0.6.2/_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.2/_sources/methoddocs/middlewares.md.txt b/v0.6.2/_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.2/_sources/methoddocs/runner.md.txt b/v0.6.2/_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.2/_sources/methoddocs/subscriptions.md.txt b/v0.6.2/_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.2/_sources/methoddocs/utils.md.txt b/v0.6.2/_sources/methoddocs/utils.md.txt
@@ -0,0 +1,7 @@
+# silverback.utils
+
+```{eval-rst}
+.. automodule:: silverback.utils
+    :members:
+    :show-inheritance:
+```