Skip to content

Commit

Permalink
Deployed 1eee0c8 to v1.3-dev with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 4, 2024
1 parent 5471387 commit 1a032c2
Show file tree
Hide file tree
Showing 39 changed files with 2,011 additions and 1,960 deletions.
8 changes: 4 additions & 4 deletions v1.3-dev/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="/_img/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">



<title>Frequenz channels</title>



<link rel="stylesheet" href="/assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="/assets/stylesheets/main.8c3ca2c6.min.css">


<link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1337,10 +1337,10 @@ <h1>404 - Not found</h1>
</div>


<script id="__config" type="application/json">{"base": "/", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "/assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "/", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "/assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>


<script src="/assets/javascripts/bundle.56dfad97.min.js"></script>
<script src="/assets/javascripts/bundle.525ec568.min.js"></script>


</body>
Expand Down
8 changes: 4 additions & 4 deletions v1.3-dev/CONTRIBUTING/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../_img/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">



<title>Contributing - Frequenz channels</title>



<link rel="stylesheet" href="../assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.8c3ca2c6.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1693,10 +1693,10 @@ <h2 id="cross-arch-testing">Cross-Arch Testing<a class="headerlink" href="#cross
</div>


<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>


<script src="../assets/javascripts/bundle.56dfad97.min.js"></script>
<script src="../assets/javascripts/bundle.525ec568.min.js"></script>


</body>
Expand Down
8 changes: 4 additions & 4 deletions v1.3-dev/SUMMARY/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="../_img/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">



<title>SUMMARY - Frequenz channels</title>



<link rel="stylesheet" href="../assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.8c3ca2c6.min.css">


<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1362,10 +1362,10 @@ <h1>SUMMARY</h1>
</div>


<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>


<script src="../assets/javascripts/bundle.56dfad97.min.js"></script>
<script src="../assets/javascripts/bundle.525ec568.min.js"></script>


</body>
Expand Down
Binary file modified v1.3-dev/_scripts/__pycache__/macros.cpython-311.pyc
Binary file not shown.
16 changes: 16 additions & 0 deletions v1.3-dev/assets/javascripts/bundle.525ec568.min.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

16 changes: 0 additions & 16 deletions v1.3-dev/assets/javascripts/bundle.56dfad97.min.js

This file was deleted.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion v1.3-dev/assets/stylesheets/main.35f28582.min.css

This file was deleted.

1 change: 0 additions & 1 deletion v1.3-dev/assets/stylesheets/main.35f28582.min.css.map

This file was deleted.

1 change: 1 addition & 0 deletions v1.3-dev/assets/stylesheets/main.8c3ca2c6.min.css

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions v1.3-dev/assets/stylesheets/main.8c3ca2c6.min.css.map

Large diffs are not rendered by default.

24 changes: 4 additions & 20 deletions v1.3-dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="_img/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">



<title>Frequenz channels</title>



<link rel="stylesheet" href="assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.8c3ca2c6.min.css">


<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1433,8 +1433,6 @@

<h1 id="frequenz-channels-for-python">Frequenz Channels for Python<a class="headerlink" href="#frequenz-channels-for-python" title="Permanent link">¤</a></h1>
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¤</a></h2>
<!-- BEGIN INCLUDE ../README.md '&lt;!-- introduction --&gt;' '&lt;!-- /introduction --&gt;' -->

<p>Frequenz Channels is a <em>channels</em> implementation for Python.</p>
<p>According to <a href="https://en.wikipedia.org/wiki/Channel_(programming)">Wikipedia</a>:</p>
<blockquote>
Expand All @@ -1447,11 +1445,7 @@ <h2 id="introduction">Introduction<a class="headerlink" href="#introduction" tit
<p>Frequenz Channels are mostly designed after <a href="https://tour.golang.org/concurrency/2">Go
channels</a> but it also borrows ideas from
<a href="https://doc.rust-lang.org/book/ch16-02-message-passing.html">Rust channels</a>.</p>
<!-- END INCLUDE -->

<h2 id="supported-platforms">Supported Platforms<a class="headerlink" href="#supported-platforms" title="Permanent link">¤</a></h2>
<!-- BEGIN INCLUDE ../README.md '&lt;!-- supported-platforms --&gt;' '&lt;!-- /supported-platforms --&gt;' -->

<p>The following platforms are officially supported (tested):</p>
<ul>
<li><strong>Python:</strong> 3.11</li>
Expand All @@ -1463,12 +1457,8 @@ <h2 id="supported-platforms">Supported Platforms<a class="headerlink" href="#sup
<p>Newer Python versions and other operating systems and architectures might
work too, but they are not automatically tested, so we cannot guarantee it.</p>
</div>
<!-- END INCLUDE -->

<h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">¤</a></h2>
<h3 id="installing">Installing<a class="headerlink" href="#installing" title="Permanent link">¤</a></h3>
<!-- BEGIN INCLUDE ../README.md '&lt;!-- quick-start-installing --&gt;' '&lt;!-- /quick-start-installing --&gt;' -->

<p>Assuming a <a href="..#supported-platforms">supported</a> working Python environment:</p>
<div class="language-sh highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>frequenz-channels
</span></code></pre></div>
Expand All @@ -1477,12 +1467,9 @@ <h3 id="installing">Installing<a class="headerlink" href="#installing" title="Pe
<p>For more details please read the <a href="user-guide/installation/">Installation
Guide</a>.</p>
</div>
<!-- END INCLUDE -->

<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¤</a></h3>
<div class="admonition example">
<p class="admonition-title">Hello World</p>
<!-- BEGIN INCLUDE ../README.md '&lt;!-- quick-start-hello-world --&gt;' '&lt;!-- /quick-start-hello-world --&gt;' -->
<div class="language-python highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">import</span> <span class="nn">asyncio</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="kn">from</span> <span class="nn">frequenz.channels</span> <span class="kn">import</span> <span class="n">Anycast</span>
Expand All @@ -1500,11 +1487,9 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
</span><span id="__span-1-15"><a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>
</span><span id="__span-1-16"><a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>
</span></code></pre></div>
<!-- END INCLUDE -->
</div>
<div class="admonition example">
<p class="admonition-title">Showcase</p>
<!-- BEGIN INCLUDE ../README.md '&lt;!-- quick-start-showcase --&gt;' '&lt;!-- /quick-start-showcase --&gt;' -->
<p>This is a comprehensive example that shows most of the main features of the
library:</p>
<div class="language-python highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="kn">import</span> <span class="nn">asyncio</span>
Expand Down Expand Up @@ -1654,7 +1639,6 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
</span><span id="__span-2-145"><a id="__codelineno-2-145" name="__codelineno-2-145" href="#__codelineno-2-145"></a>
</span><span id="__span-2-146"><a id="__codelineno-2-146" name="__codelineno-2-146" href="#__codelineno-2-146"></a><span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">main</span><span class="p">())</span>
</span></code></pre></div>
<!-- END INCLUDE -->
</div>


Expand Down Expand Up @@ -1762,10 +1746,10 @@ <h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanen
</div>


<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>


<script src="assets/javascripts/bundle.56dfad97.min.js"></script>
<script src="assets/javascripts/bundle.525ec568.min.js"></script>


</body>
Expand Down
8 changes: 4 additions & 4 deletions v1.3-dev/reference/SUMMARY/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="../../_img/logo.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.34">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">



<title>SUMMARY - Frequenz channels</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.35f28582.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8c3ca2c6.min.css">


<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1365,10 +1365,10 @@ <h1>SUMMARY</h1>
</div>


<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../../assets/javascripts/workers/search.07f07601.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.annotate", "content.code.copy", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.tabs", "navigation.top", "navigation.tracking", "toc.follow"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.56dfad97.min.js"></script>
<script src="../../assets/javascripts/bundle.525ec568.min.js"></script>


</body>
Expand Down
Loading

0 comments on commit 1a032c2

Please sign in to comment.