Deployed c4a0f60 to v0.10 with MkDocs 1.6.1 and mike 2.1.3

Author: github-actions[bot]

v0.10/index.html

@@ -1022,7 +1022,7 @@ <h2 id="usage">🛠️ Usage<a class="headerlink" href="#usage" title="Permanent
 </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
 </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">print_dispatches</span><span class="p">():</span>
 </span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>    <span class="c1"># Initialize the client</span>
-</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>    <span class="n">client</span> <span class="o">=</span> <span class="n">DispatchApiClient</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">&quot;your_api_key&quot;</span><span class="p">,</span> <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span><span class="p">)</span>
+</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>    <span class="n">client</span> <span class="o">=</span> <span class="n">DispatchApiClient</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">&quot;your_api_key&quot;</span><span class="p">,</span> <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.url.goes.here.example.com&quot;</span><span class="p">)</span>
 </span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
 </span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>    <span class="c1"># List all dispatches for a specific microgrid</span>
 </span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>    <span class="k">async</span> <span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">microgrid_id</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>

v0.10/reference/frequenz/client/dispatch/index.html

@@ -1616,7 +1616,7 @@ <h4 id="frequenz.client.dispatch.DispatchApiClient" class="doc doc-heading">
 </span><span id="__span-0-118"><a id="__codelineno-0-118" name="__codelineno-0-118"></a><span class="sd">        ```python</span>
 </span><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="sd">        client = DispatchApiClient(</span>
 </span><span id="__span-0-120"><a id="__codelineno-0-120" name="__codelineno-0-120"></a><span class="sd">            key=&quot;key&quot;,</span>
-</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">            server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">            server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-122"><a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="sd">        )</span>
 </span><span id="__span-0-123"><a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="sd">        async for page in client.list(microgrid_id=1):</span>
 </span><span id="__span-0-124"><a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="sd">            for dispatch in page:</span>
@@ -1701,7 +1701,7 @@ <h4 id="frequenz.client.dispatch.DispatchApiClient" class="doc doc-heading">
 </span><span id="__span-0-203"><a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd">        ```</span>
 </span><span id="__span-0-204"><a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd">        client = DispatchApiClient(</span>
 </span><span id="__span-0-205"><a id="__codelineno-0-205" name="__codelineno-0-205"></a><span class="sd">            key=&quot;key&quot;,</span>
-</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">            server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">            server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd">        )</span>
 </span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd">        async for message in client.stream(microgrid_id=1):</span>
 </span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd">            print(message.event, message.dispatch)</span>
@@ -3183,7 +3183,7 @@ <h6 id="frequenz.client.dispatch.DispatchApiClient.list" class="doc doc-heading"
 <p>Example usage:</p>
 <div class="language-python highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">client</span> <span class="o">=</span> <span class="n">DispatchApiClient</span><span class="p">(</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;key&quot;</span><span class="p">,</span>
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
 </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="k">async</span> <span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">microgrid_id</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>    <span class="k">for</span> <span class="n">dispatch</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
@@ -3563,7 +3563,7 @@ <h6 id="frequenz.client.dispatch.DispatchApiClient.list" class="doc doc-heading"
 </span><span id="__span-0-118"><a id="__codelineno-0-118" name="__codelineno-0-118"></a><span class="sd">    ```python</span>
 </span><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="sd">    client = DispatchApiClient(</span>
 </span><span id="__span-0-120"><a id="__codelineno-0-120" name="__codelineno-0-120"></a><span class="sd">        key=&quot;key&quot;,</span>
-</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">        server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">        server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-122"><a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="sd">    )</span>
 </span><span id="__span-0-123"><a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="sd">    async for page in client.list(microgrid_id=1):</span>
 </span><span id="__span-0-124"><a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="sd">        for dispatch in page:</span>
@@ -3666,7 +3666,7 @@ <h6 id="frequenz.client.dispatch.DispatchApiClient.stream" class="doc doc-headin
 <p>Example usage:</p>
 <div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>client = DispatchApiClient(
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    key=&quot;key&quot;,
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>)
 </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>async for message in client.stream(microgrid_id=1):
 </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>    print(message.event, message.dispatch)
@@ -3768,7 +3768,7 @@ <h6 id="frequenz.client.dispatch.DispatchApiClient.stream" class="doc doc-headin
 </span><span id="__span-0-203"><a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd">    ```</span>
 </span><span id="__span-0-204"><a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd">    client = DispatchApiClient(</span>
 </span><span id="__span-0-205"><a id="__codelineno-0-205" name="__codelineno-0-205"></a><span class="sd">        key=&quot;key&quot;,</span>
-</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">        server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">        server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd">    )</span>
 </span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd">    async for message in client.stream(microgrid_id=1):</span>
 </span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd">        print(message.event, message.dispatch)</span>

v0.10/reference/frequenz/client/dispatch/test/client/index.html

@@ -3020,7 +3020,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
 <p>Example usage:</p>
 <div class="language-python highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">client</span> <span class="o">=</span> <span class="n">DispatchApiClient</span><span class="p">(</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">key</span><span class="o">=</span><span class="s2">&quot;key&quot;</span><span class="p">,</span>
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
 </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="k">async</span> <span class="k">for</span> <span class="n">page</span> <span class="ow">in</span> <span class="n">client</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">microgrid_id</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
 </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>    <span class="k">for</span> <span class="n">dispatch</span> <span class="ow">in</span> <span class="n">page</span><span class="p">:</span>
@@ -3400,7 +3400,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
 </span><span id="__span-0-118"><a id="__codelineno-0-118" name="__codelineno-0-118"></a><span class="sd">    ```python</span>
 </span><span id="__span-0-119"><a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="sd">    client = DispatchApiClient(</span>
 </span><span id="__span-0-120"><a id="__codelineno-0-120" name="__codelineno-0-120"></a><span class="sd">        key=&quot;key&quot;,</span>
-</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">        server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-121"><a id="__codelineno-0-121" name="__codelineno-0-121"></a><span class="sd">        server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-122"><a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="sd">    )</span>
 </span><span id="__span-0-123"><a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="sd">    async for page in client.list(microgrid_id=1):</span>
 </span><span id="__span-0-124"><a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="sd">        for dispatch in page:</span>
@@ -3616,7 +3616,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
 <p>Example usage:</p>
 <div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>client = DispatchApiClient(
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    key=&quot;key&quot;,
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>)
 </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>async for message in client.stream(microgrid_id=1):
 </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>    print(message.event, message.dispatch)
@@ -3718,7 +3718,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
 </span><span id="__span-0-203"><a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd">    ```</span>
 </span><span id="__span-0-204"><a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd">    client = DispatchApiClient(</span>
 </span><span id="__span-0-205"><a id="__codelineno-0-205" name="__codelineno-0-205"></a><span class="sd">        key=&quot;key&quot;,</span>
-</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">        server_url=&quot;grpc://dispatch.eu-1.prod.api.frequenz.com:443&quot;</span>
+</span><span id="__span-0-206"><a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd">        server_url=&quot;grpc://dispatch.url.goes.here.example.com&quot;</span>
 </span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd">    )</span>
 </span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd">    async for message in client.stream(microgrid_id=1):</span>
 </span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd">        print(message.event, message.dispatch)</span>

v0.10/search/search_index.json

@@ -1 +1,113 @@
-[{"version":"v0.11-dev","title":"v0.11-dev (c4a0f60)","aliases":["v0-dev","latest-dev"]},{"version":"v0.10-dev","title":"v0.10-dev (02a3d6d)","aliases":[]},{"version":"v0.10","title":"v0.10.0","aliases":["v0","latest"]},{"version":"v0.9-dev","title":"v0.9-dev (207b4e9)","aliases":[]},{"version":"v0.9","title":"v0.9.0","aliases":[]},{"version":"v0.8-dev","title":"v0.8-dev (eb35d0d)","aliases":[]},{"version":"v0.8","title":"v0.8.5","aliases":[]},{"version":"v0.7-dev","title":"v0.7-dev (66c64a9)","aliases":[]},{"version":"v0.7","title":"v0.7.1","aliases":[]},{"version":"v0.6-dev","title":"v0.6-dev (232b3f3)","aliases":[]},{"version":"v0.6","title":"v0.6.0","aliases":[]},{"version":"v0.5-dev","title":"v0.5-dev (21f972f)","aliases":[]},{"version":"v0.5","title":"v0.5.0","aliases":[]},{"version":"v0.4-dev","title":"v0.4-dev (3c3cc8c)","aliases":[]},{"version":"v0.4","title":"v0.4.0","aliases":[]},{"version":"v0.3","title":"v0.3.0","aliases":[]},{"version":"v0.2-dev","title":"v0.2-dev (93a38b1)","aliases":[]},{"version":"v0.2","title":"v0.2.0","aliases":[]},{"version":"v0.1-dev","title":"v0.1-dev","aliases":[]},{"version":"v0.1","title":"v0.1.0","aliases":[]},{"version":"v0.0-dev","title":"v0.0-dev (df5f983)","aliases":[]}]
+[
+  {
+    "version": "v0.11-dev",
+    "title": "v0.11-dev (c4a0f60)",
+    "aliases": [
+      "latest-dev",
+      "v0-dev"
+    ]
+  },
+  {
+    "version": "v0.10",
+    "title": "v0.10.0",
+    "aliases": [
+      "latest",
+      "v0"
+    ]
+  },
+  {
+    "version": "v0.10-dev",
+    "title": "v0.10-dev (02a3d6d)",
+    "aliases": []
+  },
+  {
+    "version": "v0.9",
+    "title": "v0.9.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.9-dev",
+    "title": "v0.9-dev (207b4e9)",
+    "aliases": []
+  },
+  {
+    "version": "v0.8",
+    "title": "v0.8.5",
+    "aliases": []
+  },
+  {
+    "version": "v0.8-dev",
+    "title": "v0.8-dev (eb35d0d)",
+    "aliases": []
+  },
+  {
+    "version": "v0.7",
+    "title": "v0.7.1",
+    "aliases": []
+  },
+  {
+    "version": "v0.7-dev",
+    "title": "v0.7-dev (66c64a9)",
+    "aliases": []
+  },
+  {
+    "version": "v0.6",
+    "title": "v0.6.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.6-dev",
+    "title": "v0.6-dev (232b3f3)",
+    "aliases": []
+  },
+  {
+    "version": "v0.5",
+    "title": "v0.5.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.5-dev",
+    "title": "v0.5-dev (21f972f)",
+    "aliases": []
+  },
+  {
+    "version": "v0.4",
+    "title": "v0.4.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.4-dev",
+    "title": "v0.4-dev (3c3cc8c)",
+    "aliases": []
+  },
+  {
+    "version": "v0.3",
+    "title": "v0.3.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.2",
+    "title": "v0.2.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.2-dev",
+    "title": "v0.2-dev (93a38b1)",
+    "aliases": []
+  },
+  {
+    "version": "v0.1",
+    "title": "v0.1.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.1-dev",
+    "title": "v0.1-dev",
+    "aliases": []
+  },
+  {
+    "version": "v0.0-dev",
+    "title": "v0.0-dev (df5f983)",
+    "aliases": []
+  }
+]