Update documentation

ApeWorX · Jul 20, 2024 · 44f2116 · 44f2116
1 parent 0eb9dd7
commit 44f2116
Show file tree

Hide file tree

Showing 80 changed files with 6,098 additions and 1 deletion.
diff --git a/stable/.buildinfo b/stable/.buildinfo
@@ -1,4 +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: a129699e14723f892a52eaf02b50eb30
+config: b509c3713456bf1bb03235d868555591
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/application.doctree b/stable/.doctrees/methoddocs/application.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.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/commands/run.html b/stable/commands/run.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -47,6 +47,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/index.html b/stable/index.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/application.html b/stable/methoddocs/application.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/exceptions.html b/stable/methoddocs/exceptions.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/middlewares.html b/stable/methoddocs/middlewares.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/runner.html b/stable/methoddocs/runner.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/subscriptions.html b/stable/methoddocs/subscriptions.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/methoddocs/utils.html b/stable/methoddocs/utils.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/py-modindex.html b/stable/py-modindex.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/search.html b/stable/search.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/userguides/development.html b/stable/userguides/development.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/stable/userguides/quickstart.html b/stable/userguides/quickstart.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.4">v0.5.4</option>
                 <option value="v0.5.3">v0.5.3</option>
                 <option value="v0.5.2">v0.5.2</option>
                 <option value="v0.5.1">v0.5.1</option>

diff --git a/v0.5.5/.buildinfo b/v0.5.5/.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: b509c3713456bf1bb03235d868555591
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.5.5/.doctrees/commands/run.doctree b/v0.5.5/.doctrees/commands/run.doctree
diff --git a/v0.5.5/.doctrees/environment.pickle b/v0.5.5/.doctrees/environment.pickle
diff --git a/v0.5.5/.doctrees/index.doctree b/v0.5.5/.doctrees/index.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/application.doctree b/v0.5.5/.doctrees/methoddocs/application.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/exceptions.doctree b/v0.5.5/.doctrees/methoddocs/exceptions.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/middlewares.doctree b/v0.5.5/.doctrees/methoddocs/middlewares.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/runner.doctree b/v0.5.5/.doctrees/methoddocs/runner.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/subscriptions.doctree b/v0.5.5/.doctrees/methoddocs/subscriptions.doctree
diff --git a/v0.5.5/.doctrees/methoddocs/utils.doctree b/v0.5.5/.doctrees/methoddocs/utils.doctree
diff --git a/v0.5.5/.doctrees/userguides/development.doctree b/v0.5.5/.doctrees/userguides/development.doctree
diff --git a/v0.5.5/.doctrees/userguides/quickstart.doctree b/v0.5.5/.doctrees/userguides/quickstart.doctree
diff --git a/v0.5.5/_sources/commands/run.rst.txt b/v0.5.5/_sources/commands/run.rst.txt
@@ -0,0 +1,6 @@
+run
+***
+
+.. click:: silverback._cli:run
+  :prog: run
+  :nested: none
diff --git a/v0.5.5/_sources/index.md.txt b/v0.5.5/_sources/index.md.txt
@@ -0,0 +1,31 @@
+# Silverback Docs
+
+```{eval-rst}
+.. toctree::
+   :caption: User Guides
+   :maxdepth: 1
+
+   userguides/quickstart
+   userguides/development
+```
+
+```{eval-rst}
+.. toctree::
+   :caption: CLI Reference
+   :maxdepth: 1
+
+   commands/run.rst
+```
+
+```{eval-rst}
+.. toctree::
+   :caption: Python Reference
+   :maxdepth: 1
+
+   methoddocs/application.md
+   methoddocs/runner.md
+   methoddocs/middlewares.md
+   methoddocs/subscriptions.md
+   methoddocs/exceptions.md
+   methoddocs/utils.md
+```
diff --git a/v0.5.5/_sources/methoddocs/application.md.txt b/v0.5.5/_sources/methoddocs/application.md.txt
@@ -0,0 +1,10 @@
+# silverback.application
+
+The `silverback.application` 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.application
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.5/_sources/methoddocs/exceptions.md.txt b/v0.5.5/_sources/methoddocs/exceptions.md.txt
@@ -0,0 +1,7 @@
+# silverback.exceptions
+
+```{eval-rst}
+.. automodule:: silverback.exceptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.5/_sources/methoddocs/middlewares.md.txt b/v0.5.5/_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.5.5/_sources/methoddocs/runner.md.txt b/v0.5.5/_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.5.5/_sources/methoddocs/subscriptions.md.txt b/v0.5.5/_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.5.5/_sources/methoddocs/utils.md.txt b/v0.5.5/_sources/methoddocs/utils.md.txt
@@ -0,0 +1,7 @@
+# silverback.utils
+
+```{eval-rst}
+.. automodule:: silverback.utils
+    :members:
+    :show-inheritance:
+```