Deployed 9dd97bc with MkDocs version: 1.6.1

This commit is contained in:
2026-10-23 02:13:22 +00:00
parent 002fb2a982
commit 7206401570
4 changed files with 129 additions and 2 deletions
+1 -1
View File
@@ -3665,7 +3665,7 @@ through the tunnel. It stops at the first step that fails.</p>
</table>
<div class="admonition warning">
<p class="admonition-title">Comments are stripped</p>
<p>Writing a value through <code>cfg</code> rewrites the configuration file and <strong>removes all comments</strong> from it. If your config relies on comments, edit it by hand instead. Setting a value and using <code>--unset</code> together is an error. If a config key is set twice in the same block, <code>cfg</code> stops and gives the line numbers of the two copies. Other commands use the later copy.</p>
<p>Writing a value through <code>cfg</code> rewrites the configuration file and <strong>removes all comments</strong> from it. If your config relies on comments, edit it by hand instead. Setting a value and using <code>--unset</code> together is an error. If a config key is set twice in the same block, <code>cfg</code> stops and gives the line numbers of the two copies. Other commands warn with the same line numbers and use the later copy.</p>
</div>
<div class="admonition example">
<p class="admonition-title">Example</p>
BIN
View File
Binary file not shown.
+127
View File
@@ -1941,6 +1941,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.duplicate_key_lines" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;duplicate_key_lines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.duplicate_key_message" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;duplicate_key_message
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.load_yaml" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;load_yaml
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2183,6 +2216,39 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.duplicate_key_lines" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;duplicate_key_lines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.duplicate_key_message" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;duplicate_key_message
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.load_yaml" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;load_yaml
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2473,6 +2539,67 @@ between variables. Falls back to dot separator (scene-style) by default.</p>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.duplicate_key_lines" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">duplicate_key_lines</span>
<a href="#unshackle.core.config.duplicate_key_lines" class="headerlink" title="Permanent link">&para;</a></h2>
<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">duplicate_key_lines</span><span class="p">(</span><span class="n">root</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Return (first line, repeat line), counted from 1, for each repeated scalar key in a PyYAML or ruamel node tree.</p>
<p>Keys compare as written, so two spellings that load as the same key (yes and true, 1 and 0x1) are not found.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.duplicate_key_message" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">duplicate_key_message</span>
<a href="#unshackle.core.config.duplicate_key_message" class="headerlink" title="Permanent link">&para;</a></h2>
<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">duplicate_key_message</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">pairs</span><span class="p">,</span> <span class="n">line</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Say where a file repeats a key: each (first, repeat) pair, or <code>line</code> when no pair is known.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.load_yaml" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">load_yaml</span>
<a href="#unshackle.core.config.load_yaml" class="headerlink" title="Permanent link">&para;</a></h2>
<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">load_yaml</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>yaml.safe_load a file, and warn with the lines of each duplicate key, which PyYAML takes silently.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.get_config_path" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">get_config_path</span>
File diff suppressed because one or more lines are too long