Skip to content

Commit 6e3bbfa

Browse files
Deployed 3fc1a3b to v0.13-dev with MkDocs 1.6.1 and mike 2.1.3
1 parent f418b63 commit 6e3bbfa

File tree

5 files changed

+94
-11
lines changed

5 files changed

+94
-11
lines changed

v0.13-dev/reference/frequenz/repo/config/nox/util/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3123,7 +3123,7 @@ <h4 id="frequenz.repo.config.nox.util.replace" class="doc doc-heading">
31233123

31243124
<a href="#frequenz.repo.config.nox.util.replace" class="headerlink" title="Permanent link">¤</a></h4>
31253125
<div class="language-python doc-signature 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="nf">replace</span><span class="p">(</span>
3126-
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">iterable</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-external" title="collections.abc.Iterable" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable">Iterable</a></span><span class="p">[</span><span class="n"><span title="frequenz.repo.config.nox.util.<autoref identifier=">_T</span>" optional hover><span title="frequenz.repo.config.nox.util._T">_T</span></autoref></span><span class="p">],</span> <span class="n">replacements</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-external" title="collections.abc.Mapping" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping">Mapping</a></span><span class="p">[</span><span class="n"><span title="frequenz.repo.config.nox.util.<autoref identifier=">_T</span>" optional hover><span title="frequenz.repo.config.nox.util._T">_T</span></autoref></span><span class="p">,</span> <span class="n"><span title="frequenz.repo.config.nox.util._T">_T</span></span><span class="p">]</span>
3126+
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">iterable</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-external" title="collections.abc.Iterable" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable">Iterable</a></span><span class="p">[</span><span class="n"><span title="frequenz.repo.config.nox.util._T">_T</span></span><span class="p">],</span> <span class="n">replacements</span><span class="p">:</span> <span class="n"><a class="autorefs autorefs-external" title="collections.abc.Mapping" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping">Mapping</a></span><span class="p">[</span><span class="n"><span title="frequenz.repo.config.nox.util._T">_T</span></span><span class="p">,</span> <span class="n"><span title="frequenz.repo.config.nox.util._T">_T</span></span><span class="p">]</span>
31273127
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n"><a class="autorefs autorefs-external" title="collections.abc.Iterable" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable">Iterable</a></span><span class="p">[</span><span class="n"><span title="frequenz.repo.config.nox.util._T">_T</span></span><span class="p">]</span>
31283128
</span></code></pre></div>
31293129

v0.13-dev/search/search_index.json

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

v0.13-dev/sitemap.xml.gz

0 Bytes
Binary file not shown.

v0.13-dev/user-guide/update-an-existing-project/index.html

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1870,6 +1870,22 @@ <h2 id="use-a-migration-script">Use a migration script<a class="headerlink" href
18701870
</span></code></pre></div>
18711871
<p>Make sure that the version (<code>refs/heads/v0.x.x</code>) matches the
18721872
target version you are migrating to.</p>
1873+
<div class="admonition tip">
1874+
<p class="admonition-title">Tip for MacOS users</p>
1875+
<p>The migration script may not work out of the box on macOS. You need to
1876+
install <code>coreutils</code> to ensure compatibility:</p>
1877+
<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
1878+
</span></code></pre></div>
1879+
<p>After installation, update your <code>PATH</code> in your shell configuration
1880+
(e.g. ~/.zshrc) so that the system uses the GNU versions. Depending on
1881+
where the packages are installed this might look like this:</p>
1882+
<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>
1883+
</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>
1884+
</span></code></pre></div>
1885+
<p>Then, source your configuration file again to apply the changes:</p>
1886+
<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>
1887+
</span></code></pre></div>
1888+
</div>
18731889
<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>
18741890
<p>If you are upgrading a very old project (jumping multiple versions at the time)
18751891
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
18901906
running the <code>cookiecutter</code> command for the update.</li>
18911907
</ul>
18921908
</div>
1893-
<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>
1894-
</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>..
1895-
</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>
1896-
</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>
1897-
</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.x.x<span class="w"> </span><span class="se">\</span>
1898-
</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>
1899-
</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>
1900-
</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
1909+
<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>
1910+
</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>..
1911+
</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>
1912+
</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>
1913+
</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.x.x<span class="w"> </span><span class="se">\</span>
1914+
</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>
1915+
</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>
1916+
</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
19011917
</span></code></pre></div>
19021918
<p>This will create a new commit with all the changes to the overwritten files.
19031919
Bear in mind that all the <code>TODO</code>s will come back, so there will be quite a bit

versions.json

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,68 @@
1-
[{"version":"v0.13-dev","title":"v0.13-dev (6aaa39d)","aliases":["v0-dev","latest-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":[]}]
1+
[
2+
{
3+
"version": "v0.13-dev",
4+
"title": "v0.13-dev (3fc1a3b)",
5+
"aliases": [
6+
"latest-dev",
7+
"v0-dev"
8+
]
9+
},
10+
{
11+
"version": "v0.12",
12+
"title": "v0.12.2",
13+
"aliases": [
14+
"latest",
15+
"v0"
16+
]
17+
},
18+
{
19+
"version": "v0.12-dev",
20+
"title": "v0.12-dev (07780ea)",
21+
"aliases": []
22+
},
23+
{
24+
"version": "v0.11",
25+
"title": "v0.11.0",
26+
"aliases": []
27+
},
28+
{
29+
"version": "v0.10",
30+
"title": "v0.10.0",
31+
"aliases": []
32+
},
33+
{
34+
"version": "v0.9",
35+
"title": "v0.9.2",
36+
"aliases": []
37+
},
38+
{
39+
"version": "v0.8",
40+
"title": "v0.8.0",
41+
"aliases": []
42+
},
43+
{
44+
"version": "v0.7",
45+
"title": "v0.7.5",
46+
"aliases": []
47+
},
48+
{
49+
"version": "v0.6",
50+
"title": "v0.6.2",
51+
"aliases": []
52+
},
53+
{
54+
"version": "v0.5",
55+
"title": "v0.5.2",
56+
"aliases": []
57+
},
58+
{
59+
"version": "v0.4",
60+
"title": "v0.4.0",
61+
"aliases": []
62+
},
63+
{
64+
"version": "v0.3",
65+
"title": "v0.3.0",
66+
"aliases": []
67+
}
68+
]

0 commit comments

Comments
 (0)