Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 5, 2024
1 parent 8120db2 commit eb31112
Show file tree
Hide file tree
Showing 88 changed files with 8,308 additions and 1 deletion.
2 changes: 1 addition & 1 deletion stable/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: 04ac3ad989f285030894648dfaf191ef
config: eccb4ac90fbac81dc36d7b7514cd43c4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified stable/.doctrees/environment.pickle
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/application.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/middlewares.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/runner.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/subscriptions.doctree
Binary file not shown.
Binary file modified stable/.doctrees/methoddocs/utils.doctree
Binary file not shown.
1 change: 1 addition & 0 deletions stable/commands/cluster.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/commands/run.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/application.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/middlewares.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/runner.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/subscriptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/methoddocs/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/userguides/development.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/userguides/platform.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
1 change: 1 addition & 0 deletions stable/userguides/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<option value="">Select version...</option>
<option value="latest">latest</option>
<option value="stable">stable</option>
<option value="v0.5.6">v0.5.6</option>
<option value="v0.5.5">v0.5.5</option>
<option value="v0.5.4">v0.5.4</option>
<option value="v0.5.3">v0.5.3</option>
Expand Down
4 changes: 4 additions & 0 deletions v0.5.7/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: eccb4ac90fbac81dc36d7b7514cd43c4
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added v0.5.7/.doctrees/commands/cluster.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/commands/run.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/environment.pickle
Binary file not shown.
Binary file added v0.5.7/.doctrees/index.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/methoddocs/application.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/methoddocs/middlewares.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/methoddocs/runner.doctree
Binary file not shown.
Binary file not shown.
Binary file added v0.5.7/.doctrees/methoddocs/utils.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/userguides/development.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/userguides/platform.doctree
Binary file not shown.
Binary file added v0.5.7/.doctrees/userguides/quickstart.doctree
Binary file not shown.
21 changes: 21 additions & 0 deletions v0.5.7/_sources/commands/cluster.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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:bots
:prog: silverback cluster bots
:nested: full
:commands: new, list, info, update, remove, health, start, stop, logs, errors
10 changes: 10 additions & 0 deletions v0.5.7/_sources/commands/run.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Local Development
*****************

.. click:: silverback._cli:run
:prog: silverback run
:nested: none

.. click:: silverback._cli:worker
:prog: silverback worker
:nested: none
33 changes: 33 additions & 0 deletions v0.5.7/_sources/index.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Silverback Docs

```{eval-rst}
.. toctree::
:caption: User Guides
:maxdepth: 1

userguides/quickstart
userguides/development
userguides/platform
```

```{eval-rst}
.. toctree::
:caption: CLI Reference
:maxdepth: 1

commands/run.rst
commands/cluster.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
```
10 changes: 10 additions & 0 deletions v0.5.7/_sources/methoddocs/application.md.txt
Original file line number Diff line number Diff line change
@@ -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:
```
7 changes: 7 additions & 0 deletions v0.5.7/_sources/methoddocs/exceptions.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# silverback.exceptions

```{eval-rst}
.. automodule:: silverback.exceptions
:members:
:show-inheritance:
```
10 changes: 10 additions & 0 deletions v0.5.7/_sources/methoddocs/middlewares.md.txt
Original file line number Diff line number Diff line change
@@ -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:
```
10 changes: 10 additions & 0 deletions v0.5.7/_sources/methoddocs/runner.md.txt
Original file line number Diff line number Diff line change
@@ -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:
```
10 changes: 10 additions & 0 deletions v0.5.7/_sources/methoddocs/subscriptions.md.txt
Original file line number Diff line number Diff line change
@@ -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:
```
7 changes: 7 additions & 0 deletions v0.5.7/_sources/methoddocs/utils.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# silverback.utils

```{eval-rst}
.. automodule:: silverback.utils
:members:
:show-inheritance:
```
Loading

0 comments on commit eb31112

Please sign in to comment.