Deployed 3fc1a3b to v0.12 with MkDocs 1.6.1 and mike 2.1.3

Author: github-actions[bot]

v0.12/reference/frequenz/repo/config/index.html

@@ -2302,7 +2302,7 @@ <h5 id="frequenz.repo.config--linting-examples-in-the-source-codes-docstrings">L
 </span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="c1"># ...</span>
 </span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="n">dev-pytest</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
 </span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w">    </span><span class="c1"># ...</span>
-</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w">    </span><span class="s2">&quot;frequenz-repo-config[extra-lint-examples] @ git+https://github.com/frequenz-floss/frequenz-repo-config-python@0704c594abdb6c3bf1fbc63a1815ce0e770a6ab7&quot;</span><span class="p">,</span>
+</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w">    </span><span class="s2">&quot;frequenz-repo-config[extra-lint-examples] @ git+https://github.com/frequenz-floss/frequenz-repo-config-python@3fc1a3b0f449446a666f284833e19641965b4c1a&quot;</span><span class="p">,</span>
 </span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="p">]</span>
 </span><span id="__span-10-7"><a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="c1"># ...</span>
 </span><span id="__span-10-8"><a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="k">[[tool.mypy.overrides]]</span>
@@ -2391,7 +2391,7 @@ <h5 id="frequenz.repo.config--setuptools-grpc-support"><code>setuptools</code> g
 <div class="language-toml highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="n">requires</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
 </span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="w">  </span><span class="s2">&quot;setuptools &gt;= 67.3.2, &lt; 68&quot;</span><span class="p">,</span>
 </span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="w">  </span><span class="s2">&quot;setuptools_scm[toml] &gt;= 7.1.0, &lt; 8&quot;</span><span class="p">,</span>
-</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="w">  </span><span class="s2">&quot;frequenz-repo-config[api] @ git+https://github.com/frequenz-floss/frequenz-repo-config-python@0704c594abdb6c3bf1fbc63a1815ce0e770a6ab7&quot;</span><span class="p">,</span>
+</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="w">  </span><span class="s2">&quot;frequenz-repo-config[api] @ git+https://github.com/frequenz-floss/frequenz-repo-config-python@3fc1a3b0f449446a666f284833e19641965b4c1a&quot;</span><span class="p">,</span>
 </span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="p">]</span>
 </span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">build-backend</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;setuptools.build_meta&quot;</span>
 </span><span id="__span-15-7"><a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a>

v0.12/search/search_index.json

@@ -1784,7 +1784,7 @@ <h1 id="migrate-an-existing-project">Migrate an existing project<a class="header
 the files in your existing project by using <code>rsync</code> or similar tools:</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><span class="nb">cd</span><span class="w"> </span>/tmp
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>cookiecutter<span class="w"> </span>gh:frequenz-floss/frequenz-repo-config-python<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span>--checkout<span class="w"> </span>v0.12.2
+</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span>--checkout<span class="w"> </span>v0.12.3
 </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>rsync<span class="w"> </span>-vr<span class="w"> </span>--exclude<span class="o">=</span>.git/<span class="w"> </span>new-project/<span class="w"> </span>/path/to/existing/project
 </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="nb">cd</span><span class="w"> </span>/path/to/existing/project
 </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>git<span class="w"> </span>diff

v0.12/sitemap.xml.gz

@@ -2286,25 +2286,25 @@ <h4 id="rulesets">Rulesets<a class="headerlink" href="#rulesets" title="Permanen
 branches</em> ruleset depending on your repository configuration.</p>
 </div>
 <ul>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/Disable creation of non-release tags.json">Disable creation of non-release
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/Disable creation of non-release tags.json">Disable creation of non-release
   tags</a></li>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/Disable creation of other branches.json">Disable creation of other
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/Disable creation of other branches.json">Disable creation of other
   branches</a></li>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/Disallow removal and force-pushes of gh-pages.json">Disallow removal and force-pushes of
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/Disallow removal and force-pushes of gh-pages.json">Disallow removal and force-pushes of
   gh-pages</a></li>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/Protect released tags.json">Protect released
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/Protect released tags.json">Protect released
   tags</a></li>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/Queue PRs for the default branch.json">Queue PRs for the default
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/Queue PRs for the default branch.json">Queue PRs for the default
   branch</a></li>
 </ul>
 <h5 id="python-specific-rulesets">Python specific rulesets<a class="headerlink" href="#python-specific-rulesets" title="Permanent link">¤</a></h5>
 <ul>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/python/Protect version branches.json">Protect version
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/python/Protect version branches.json">Protect version
   branches</a></li>
 </ul>
 <h5 id="rust-specific-rulesets">Rust specific rulesets<a class="headerlink" href="#rust-specific-rulesets" title="Permanent link">¤</a></h5>
 <ul>
-<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.2/github-rulesets/rust/Protect version branches.json">Protect version
+<li><a href="https://github.com/frequenz-floss/frequenz-repo-config-python/blob/v0.12.3/github-rulesets/rust/Protect version branches.json">Protect version
   branches</a></li>
 </ul>
 <h3 id="code-security-and-analysis">Code security and analysis<a class="headerlink" href="#code-security-and-analysis" title="Permanent link">¤</a></h3>

v0.12/user-guide/migrate-an-existing-project/index.html

@@ -1885,7 +1885,7 @@ <h2 id="install-cookiecutter">Install Cookiecutter<a class="headerlink" href="#i
 <p>Then simply run [Cookiecutter] where you want to create the new project:</p>
 <h2 id="generate-the-project-files">Generate the project files<a class="headerlink" href="#generate-the-project-files" title="Permanent link">¤</a></h2>
 <div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>cookiecutter<span class="w"> </span>gh:frequenz-floss/frequenz-repo-config-python<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span>--checkout<span class="w"> </span>v0.12.2
+</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span>--checkout<span class="w"> </span>v0.12.3
 </span></code></pre></div>
 <p>This command will prompt you for the project type, name, and other
 configuration options, and it will generate the entire project for you in a new

v0.12/user-guide/start-a-new-project/configure-github/index.html

@@ -1865,11 +1865,27 @@ <h2 id="use-a-migration-script">Use a migration script<a class="headerlink" href
 skipping versions, you will have to run the script multiple times.</p>
 <p>The easiest way to run the migration script is to fetch it from GitHub and run
 it directly.</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>curl<span class="w"> </span>-sSL<span class="w"> </span>https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/refs/tags/v0.12.2/cookiecutter/migrate.py<span class="w"> </span><span class="se">\</span>
+<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>curl<span class="w"> </span>-sSL<span class="w"> </span>https://raw.githubusercontent.com/frequenz-floss/frequenz-repo-config-python/refs/tags/v0.12.3/cookiecutter/migrate.py<span class="w"> </span><span class="se">\</span>
 </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w">    </span><span class="p">|</span><span class="w"> </span>python3
 </span></code></pre></div>
-<p>Make sure that the version (<code>refs/tags/v0.12.2</code>) matches the
+<p>Make sure that the version (<code>refs/tags/v0.12.3</code>) matches the
 target version you are migrating to.</p>
+<div class="admonition tip">
+<p class="admonition-title">Tip for MacOS users</p>
+<p>The migration script may not work out of the box on macOS. You need to
+install <code>coreutils</code> to ensure compatibility:</p>
+<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>brew<span class="w"> </span>install<span class="w"> </span>coreutils<span class="w"> </span>gnu-sed
+</span></code></pre></div>
+<p>After installation, update your <code>PATH</code> in your shell configuration
+(e.g. ~/.zshrc) so that the system uses the GNU versions. Depending on
+where the packages are installed this might look like this:</p>
+<div class="language-sh 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="nb">export</span><span class="w"> </span><span class="nv">PATH</span><span class="o">=</span><span class="s2">&quot;/opt/homebrew/opt/coreutils/libexec/gnubin:/opt/homebrew/opt/gnu-sed/libexec/gnubin:</span><span class="nv">$PATH</span><span class="s2">&quot;</span>
+</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nb">export</span><span class="w"> </span><span class="nv">MANPATH</span><span class="o">=</span><span class="s2">&quot;/opt/homebrew/opt/coreutils/libexec/gnuman:</span><span class="nv">$MANPATH</span><span class="s2">&quot;</span>
+</span></code></pre></div>
+<p>Then, source your configuration file again to apply the changes:</p>
+<div class="language-sh highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nb">source</span><span class="w"> </span>~/.zshrc<span class="w">  </span><span class="c1"># or ~/.bashrc, depending on your shell</span>
+</span></code></pre></div>
+</div>
 <h2 id="re-run-the-cookiecutter-command">Re-run the Cookiecutter command<a class="headerlink" href="#re-run-the-cookiecutter-command" title="Permanent link">¤</a></h2>
 <p>If you are upgrading a very old project (jumping multiple versions at the time)
 it is probably easier to just regenerate the whole project.</p>
@@ -1890,14 +1906,14 @@ <h2 id="re-run-the-cookiecutter-command">Re-run the Cookiecutter command<a class
   running the <code>cookiecutter</code> command for the update.</li>
 </ul>
 </div>
-<div class="language-sh highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>git<span class="w"> </span>commit<span class="w"> </span>-a<span class="w">  </span><span class="c1"># commit all changes</span>
-</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nb">cd</span><span class="w"> </span>..
-</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>cookiecutter<span class="w"> </span>gh:frequenz-floss/frequenz-repo-config-python<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">    </span>--checkout<span class="w"> </span>v0.12.2<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">    </span>--overwrite-if-exists<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">    </span>--replay<span class="w"> </span><span class="se">\</span>
-</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">    </span>--replay-file<span class="w"> </span>project-directory/.cookiecutter-replay.json
+<div class="language-sh highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>git<span class="w"> </span>commit<span class="w"> </span>-a<span class="w">  </span><span class="c1"># commit all changes</span>
+</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nb">cd</span><span class="w"> </span>..
+</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>cookiecutter<span class="w"> </span>gh:frequenz-floss/frequenz-repo-config-python<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w">    </span>--directory<span class="o">=</span>cookiecutter<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w">    </span>--checkout<span class="w"> </span>v0.12.3<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w">    </span>--overwrite-if-exists<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w">    </span>--replay<span class="w"> </span><span class="se">\</span>
+</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w">    </span>--replay-file<span class="w"> </span>project-directory/.cookiecutter-replay.json
 </span></code></pre></div>
 <p>This will create a new commit with all the changes to the overwritten files.
 Bear in mind that all the <code>TODO</code>s will come back, so there will be quite a bit

v0.12/user-guide/start-a-new-project/index.html

@@ -1 +1,68 @@
-[{"version":"v0.13-dev","title":"v0.13-dev (3fc1a3b)","aliases":["latest-dev","v0-dev"]},{"version":"v0.12-dev","title":"v0.12-dev (07780ea)","aliases":[]},{"version":"v0.12","title":"v0.12.2","aliases":["latest","v0"]},{"version":"v0.11","title":"v0.11.0","aliases":[]},{"version":"v0.10","title":"v0.10.0","aliases":[]},{"version":"v0.9","title":"v0.9.2","aliases":[]},{"version":"v0.8","title":"v0.8.0","aliases":[]},{"version":"v0.7","title":"v0.7.5","aliases":[]},{"version":"v0.6","title":"v0.6.2","aliases":[]},{"version":"v0.5","title":"v0.5.2","aliases":[]},{"version":"v0.4","title":"v0.4.0","aliases":[]},{"version":"v0.3","title":"v0.3.0","aliases":[]}]
+[
+  {
+    "version": "v0.13-dev",
+    "title": "v0.13-dev (3fc1a3b)",
+    "aliases": [
+      "latest-dev",
+      "v0-dev"
+    ]
+  },
+  {
+    "version": "v0.12",
+    "title": "v0.12.3",
+    "aliases": [
+      "v0",
+      "latest"
+    ]
+  },
+  {
+    "version": "v0.12-dev",
+    "title": "v0.12-dev (07780ea)",
+    "aliases": []
+  },
+  {
+    "version": "v0.11",
+    "title": "v0.11.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.10",
+    "title": "v0.10.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.9",
+    "title": "v0.9.2",
+    "aliases": []
+  },
+  {
+    "version": "v0.8",
+    "title": "v0.8.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.7",
+    "title": "v0.7.5",
+    "aliases": []
+  },
+  {
+    "version": "v0.6",
+    "title": "v0.6.2",
+    "aliases": []
+  },
+  {
+    "version": "v0.5",
+    "title": "v0.5.2",
+    "aliases": []
+  },
+  {
+    "version": "v0.4",
+    "title": "v0.4.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.3",
+    "title": "v0.3.0",
+    "aliases": []
+  }
+]