Update documentation

ApeWorX · Sep 15, 2023 · 569dc99 · 569dc99
1 parent 85da69d
commit 569dc99
Show file tree

Hide file tree

Showing 73 changed files with 7,506 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/index.html b/index.html
@@ -1,3 +1,4 @@
+
 <!DOCTYPE html>
 <meta charset="utf-8">
 <title>Redirecting...</title>

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