Update documentation

ApeWorX · May 25, 2024 · 8cf0f5d · 8cf0f5d
1 parent 329f433
commit 8cf0f5d
Show file tree

Hide file tree

Showing 24 changed files with 19 additions and 6 deletions.
diff --git a/latest/.buildinfo b/latest/.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: 25c16bedfd726ba075ccbe6ed9cccf26
+config: 2c881fc5dc6b3a4601885f984b2bb90e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
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/development.doctree b/latest/.doctrees/userguides/development.doctree
diff --git a/latest/_sources/userguides/development.md.txt b/latest/_sources/userguides/development.md.txt
@@ -156,7 +156,7 @@ For this to work, you must configure a [TaskIQ broker](https://taskiq-python.git
 
 ```bash
 export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
-export SILVERBACK_BROKER_URI="redis://127.0.0.1:6379"
+export SILVERBACK_BROKER_KWARGS='{"queue_name": "taskiq", "url": "redis://127.0.0.1:6379"}'
 
 silverback run "example:app" \
     --network :mainnet:alchemy \
@@ -167,7 +167,7 @@ And then the worker process with 2 worker subprocesses:
 
 ```bash
 export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
-export SILVERBACK_BROKER_URI="redis://127.0.0.1:6379"
+export SILVERBACK_BROKER_KWARGS='{"url": "redis://127.0.0.1:6379"}'
 
 silverback worker -w 2 "example:app"
 ```

diff --git a/latest/commands/run.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/genindex.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/index.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/application.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/exceptions.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/middlewares.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/runner.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/subscriptions.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/methoddocs/utils.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/py-modindex.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/search.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/development.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>
@@ -269,7 +270,7 @@ <h3>Distributed Execution<a class="headerlink" href="#distributed-execution" tit
 <p>The primary components are the client and workers.  The client handles Silverback events (blocks and contract event logs) and creates jobs for the workers to process in an asynchronous manner.</p>
 <p>For this to work, you must configure a <a class="reference external" href="https://taskiq-python.github.io/guide/architecture-overview.html#broker">TaskIQ broker</a> capable of distributed processing.  For instance, with <a class="reference external" href="https://github.com/taskiq-python/taskiq-redis"><code class="docutils literal notranslate"><span class="pre">taskiq_redis</span></code></a> you could do something like this for the client:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_CLASS</span><span class="o">=</span><span class="s2">&quot;taskiq_redis:ListQueueBroker&quot;</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_URI</span><span class="o">=</span><span class="s2">&quot;redis://127.0.0.1:6379&quot;</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_KWARGS</span><span class="o">=</span><span class="s1">&#39;{&quot;queue_name&quot;: &quot;taskiq&quot;, &quot;url&quot;: &quot;redis://127.0.0.1:6379&quot;}&#39;</span>
 
 silverback<span class="w"> </span>run<span class="w"> </span><span class="s2">&quot;example:app&quot;</span><span class="w"> </span><span class="se">\</span>
 <span class="w">    </span>--network<span class="w"> </span>:mainnet:alchemy<span class="w"> </span><span class="se">\</span>
@@ -278,7 +279,7 @@ <h3>Distributed Execution<a class="headerlink" href="#distributed-execution" tit
 </div>
 <p>And then the worker process with 2 worker subprocesses:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_CLASS</span><span class="o">=</span><span class="s2">&quot;taskiq_redis:ListQueueBroker&quot;</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_URI</span><span class="o">=</span><span class="s2">&quot;redis://127.0.0.1:6379&quot;</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_KWARGS</span><span class="o">=</span><span class="s1">&#39;{&quot;url&quot;: &quot;redis://127.0.0.1:6379&quot;}&#39;</span>
 
 silverback<span class="w"> </span>worker<span class="w"> </span>-w<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="s2">&quot;example:app&quot;</span>
 </pre></div>

diff --git a/latest/userguides/quickstart.html b/latest/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.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>