Skip to content

Commit 9def433

Browse files
Deployed 5ebdbcb to v0.10-dev with MkDocs 1.6.1 and mike 2.1.3
1 parent df0e086 commit 9def433

File tree

6 files changed

+176
-74
lines changed

6 files changed

+176
-74
lines changed

v0.10-dev/objects.inv

0 Bytes
Binary file not shown.

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

Lines changed: 66 additions & 66 deletions
Large diffs are not rendered by default.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1611,7 +1611,7 @@ <h4 id="frequenz.client.dispatch.test.client.FakeClient" class="doc doc-heading"
16111611

16121612
<div class="doc doc-contents ">
16131613
<p class="doc doc-class-bases">
1614-
Bases: <code><a class="autorefs autorefs-internal" title="frequenz.client.dispatch.Client" href="../../#frequenz.client.dispatch.Client">Client</a></code></p>
1614+
Bases: <code><a class="autorefs autorefs-internal" title="frequenz.client.dispatch.DispatchApiClient" href="../../#frequenz.client.dispatch.DispatchApiClient">DispatchApiClient</a></code></p>
16151615

16161616

16171617
<p>Fake client for testing.</p>
@@ -1684,7 +1684,7 @@ <h4 id="frequenz.client.dispatch.test.client.FakeClient" class="doc doc-heading"
16841684
<span class="normal"><a href="#__codelineno-0-71">71</a></span>
16851685
<span class="normal"><a href="#__codelineno-0-72">72</a></span>
16861686
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
1687-
<span class="normal"><a href="#__codelineno-0-74">74</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="k">class</span><span class="w"> </span><span class="nc">FakeClient</span><span class="p">(</span><span class="n">Client</span><span class="p">):</span>
1687+
<span class="normal"><a href="#__codelineno-0-74">74</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="k">class</span><span class="w"> </span><span class="nc">FakeClient</span><span class="p">(</span><span class="n">DispatchApiClient</span><span class="p">):</span>
16881688
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Fake client for testing.</span>
16891689
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17"></a>
16901690
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="sd"> This client uses a fake service to simulate the dispatch api.</span>
@@ -3018,7 +3018,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
30183018
over the dispatches. Pagination parameters like <code>page_size</code> and <code>page_token</code>
30193019
can be used, but they are mutually exclusive.</p>
30203020
<p>Example usage:</p>
3021-
<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">Client</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s2">&quot;key&quot;</span><span class="p">,</span> <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://fz-0004.frequenz.io&quot;</span><span class="p">)</span>
3021+
<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 class="n">key</span><span class="o">=</span><span class="s2">&quot;key&quot;</span><span class="p">,</span> <span class="n">server_url</span><span class="o">=</span><span class="s2">&quot;grpc://fz-0004.frequenz.io&quot;</span><span class="p">)</span>
30223022
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></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>
30233023
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></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>
30243024
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="nb">print</span><span class="p">(</span><span class="n">dispatch</span><span class="p">)</span>
@@ -3392,7 +3392,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.list" class="doc doc-hea
33923392
</span><span id="__span-0-125"><a id="__codelineno-0-125" name="__codelineno-0-125"></a><span class="sd"> Example usage:</span>
33933393
</span><span id="__span-0-126"><a id="__codelineno-0-126" name="__codelineno-0-126"></a>
33943394
</span><span id="__span-0-127"><a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="sd"> ```python</span>
3395-
</span><span id="__span-0-128"><a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> client = Client(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)</span>
3395+
</span><span id="__span-0-128"><a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> client = DispatchApiClient(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)</span>
33963396
</span><span id="__span-0-129"><a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> async for page in client.list(microgrid_id=1):</span>
33973397
</span><span id="__span-0-130"><a id="__codelineno-0-130" name="__codelineno-0-130"></a><span class="sd"> for dispatch in page:</span>
33983398
</span><span id="__span-0-131"><a id="__codelineno-0-131" name="__codelineno-0-131"></a><span class="sd"> print(dispatch)</span>
@@ -3605,7 +3605,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
36053605
dispatch events.
36063606
An event is one of [CREATE, UPDATE, DELETE].</p>
36073607
<p>Example usage:</p>
3608-
<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 = Client(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)
3608+
<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(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)
36093609
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>async for message in client.stream(microgrid_id=1):
36103610
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> print(message.event, message.dispatch)
36113611
</span></code></pre></div>
@@ -3701,7 +3701,7 @@ <h6 id="frequenz.client.dispatch.test.client.FakeClient.stream" class="doc doc-h
37013701
</span><span id="__span-0-207"><a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd"> Example usage:</span>
37023702
</span><span id="__span-0-208"><a id="__codelineno-0-208" name="__codelineno-0-208"></a>
37033703
</span><span id="__span-0-209"><a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd"> ```</span>
3704-
</span><span id="__span-0-210"><a id="__codelineno-0-210" name="__codelineno-0-210"></a><span class="sd"> client = Client(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)</span>
3704+
</span><span id="__span-0-210"><a id="__codelineno-0-210" name="__codelineno-0-210"></a><span class="sd"> client = DispatchApiClient(key=&quot;key&quot;, server_url=&quot;grpc://fz-0004.frequenz.io&quot;)</span>
37053705
</span><span id="__span-0-211"><a id="__codelineno-0-211" name="__codelineno-0-211"></a><span class="sd"> async for message in client.stream(microgrid_id=1):</span>
37063706
</span><span id="__span-0-212"><a id="__codelineno-0-212" name="__codelineno-0-212"></a><span class="sd"> print(message.event, message.dispatch)</span>
37073707
</span><span id="__span-0-213"><a id="__codelineno-0-213" name="__codelineno-0-213"></a><span class="sd"> ```</span>

v0.10-dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

v0.10-dev/sitemap.xml.gz

0 Bytes
Binary file not shown.

versions.json

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,103 @@
1-
[{"version":"v0.10-dev","title":"v0.10-dev (31a5008)","aliases":["v0-dev","latest-dev"]},{"version":"v0.9-dev","title":"v0.9-dev (207b4e9)","aliases":[]},{"version":"v0.9","title":"v0.9.0","aliases":["v0","latest"]},{"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":[]}]
1+
[
2+
{
3+
"version": "v0.10-dev",
4+
"title": "v0.10-dev (5ebdbcb)",
5+
"aliases": [
6+
"latest-dev",
7+
"v0-dev"
8+
]
9+
},
10+
{
11+
"version": "v0.9",
12+
"title": "v0.9.0",
13+
"aliases": [
14+
"latest",
15+
"v0"
16+
]
17+
},
18+
{
19+
"version": "v0.9-dev",
20+
"title": "v0.9-dev (207b4e9)",
21+
"aliases": []
22+
},
23+
{
24+
"version": "v0.8",
25+
"title": "v0.8.5",
26+
"aliases": []
27+
},
28+
{
29+
"version": "v0.8-dev",
30+
"title": "v0.8-dev (eb35d0d)",
31+
"aliases": []
32+
},
33+
{
34+
"version": "v0.7",
35+
"title": "v0.7.1",
36+
"aliases": []
37+
},
38+
{
39+
"version": "v0.7-dev",
40+
"title": "v0.7-dev (66c64a9)",
41+
"aliases": []
42+
},
43+
{
44+
"version": "v0.6",
45+
"title": "v0.6.0",
46+
"aliases": []
47+
},
48+
{
49+
"version": "v0.6-dev",
50+
"title": "v0.6-dev (232b3f3)",
51+
"aliases": []
52+
},
53+
{
54+
"version": "v0.5",
55+
"title": "v0.5.0",
56+
"aliases": []
57+
},
58+
{
59+
"version": "v0.5-dev",
60+
"title": "v0.5-dev (21f972f)",
61+
"aliases": []
62+
},
63+
{
64+
"version": "v0.4",
65+
"title": "v0.4.0",
66+
"aliases": []
67+
},
68+
{
69+
"version": "v0.4-dev",
70+
"title": "v0.4-dev (3c3cc8c)",
71+
"aliases": []
72+
},
73+
{
74+
"version": "v0.3",
75+
"title": "v0.3.0",
76+
"aliases": []
77+
},
78+
{
79+
"version": "v0.2",
80+
"title": "v0.2.0",
81+
"aliases": []
82+
},
83+
{
84+
"version": "v0.2-dev",
85+
"title": "v0.2-dev (93a38b1)",
86+
"aliases": []
87+
},
88+
{
89+
"version": "v0.1",
90+
"title": "v0.1.0",
91+
"aliases": []
92+
},
93+
{
94+
"version": "v0.1-dev",
95+
"title": "v0.1-dev",
96+
"aliases": []
97+
},
98+
{
99+
"version": "v0.0-dev",
100+
"title": "v0.0-dev (df5f983)",
101+
"aliases": []
102+
}
103+
]

0 commit comments

Comments
 (0)