Skip to content

Commit 2e7d5cd

Browse files
committed
Deploying to gh-pages from @ 7404820 🚀
1 parent d42225e commit 2e7d5cd

4 files changed

+41
-41
lines changed

Diff for: api/docker_tag_updater.helpers.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -260,22 +260,22 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
260260
<dl class="field-list simple">
261261
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
262262
<dd class="field-odd"><ul class="simple">
263-
<li><p><strong>version</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – A semver string.</p></li>
263+
<li><p><strong>version</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – A semver string.</p></li>
264264
<li><p><strong>rules</strong> – A set of RegexRules.</p></li>
265-
<li><p><strong>rule_name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule, or its alias.
265+
<li><p><strong>rule_name</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule, or its alias.
266266
Default <code class="docutils literal notranslate"><span class="pre">'default'</span></code>.</p></li>
267267
</ul>
268268
</dd>
269269
<dt class="field-even">Return type<span class="colon">:</span></dt>
270-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span></p>
270+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span></p>
271271
</dd>
272272
<dt class="field-odd">Returns<span class="colon">:</span></dt>
273273
<dd class="field-odd"><p>A dictionary that can be parsed by python-semver.</p>
274274
</dd>
275275
<dt class="field-even">Raises<span class="colon">:</span></dt>
276276
<dd class="field-even"><ul class="simple">
277-
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#KeyError" title="(in Python v3.12)"><strong>KeyError</strong></a> – If rule_name is not the name or alias of a rule in the rules RegexRules object.</p></li>
278-
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – If there the version cannot be parsed by either the specified rule or
277+
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#KeyError" title="(in Python v3.13)"><strong>KeyError</strong></a> – If rule_name is not the name or alias of a rule in the rules RegexRules object.</p></li>
278+
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If there the version cannot be parsed by either the specified rule or
279279
the default rule.</p></li>
280280
</ul>
281281
</dd>

Diff for: api/docker_tag_updater.helpers.regex_rules.html

+10-10
Original file line numberDiff line numberDiff line change
@@ -237,11 +237,11 @@
237237
<dl class="py class">
238238
<dt class="sig sig-object py" id="docker_tag_updater.helpers.regex_rules.RegexRules">
239239
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RegexRules</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rules</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#docker_tag_updater.helpers.regex_rules.RegexRules" title="Link to this definition">#</a></dt>
240-
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
240+
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
241241
<p>An aliased dictionary with defined regex rules for version parsing.</p>
242242
<dl class="field-list simple">
243243
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
244-
<dd class="field-odd"><p><strong>rules</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A dictionary containing names as keys and regex strings as values.</p>
244+
<dd class="field-odd"><p><strong>rules</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]</span>) – A dictionary containing names as keys and regex strings as values.</p>
245245
</dd>
246246
</dl>
247247
<p class="rubric">Examples</p>
@@ -271,12 +271,12 @@
271271
<dl class="field-list simple">
272272
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
273273
<dd class="field-odd"><ul class="simple">
274-
<li><p><strong>main_rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name main rule to add aliases to.</p></li>
275-
<li><p><strong>aliases</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – Strings of aliases to the main rule.</p></li>
274+
<li><p><strong>main_rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name main rule to add aliases to.</p></li>
275+
<li><p><strong>aliases</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – Strings of aliases to the main rule.</p></li>
276276
</ul>
277277
</dd>
278278
<dt class="field-even">Return type<span class="colon">:</span></dt>
279-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
279+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span></p>
280280
</dd>
281281
</dl>
282282
<p class="rubric">Examples</p>
@@ -285,7 +285,7 @@
285285
&gt;&gt;&gt; DefaultRules.add_alias(“default”, “docker.io”, “docker”)</p>
286286
<dl class="field-list simple">
287287
<dt class="field-odd">Raises<span class="colon">:</span></dt>
288-
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – If there are no aliases to be added.</p>
288+
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.13)"><strong>NotImplementedError</strong></a> – If there are no aliases to be added.</p>
289289
</dd>
290290
</dl>
291291
</dd></dl>
@@ -296,10 +296,10 @@
296296
<dd><p>Redefine the get function.</p>
297297
<dl class="field-list simple">
298298
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
299-
<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule or its alias.</p>
299+
<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule or its alias.</p>
300300
</dd>
301301
<dt class="field-even">Return type<span class="colon">:</span></dt>
302-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p>
302+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></p>
303303
</dd>
304304
<dt class="field-odd">Returns<span class="colon">:</span></dt>
305305
<dd class="field-odd"><p>A regex raw string.</p>
@@ -318,10 +318,10 @@
318318
<dd><p>Check if the rule exists or is an alias.</p>
319319
<dl class="field-list simple">
320320
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
321-
<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule to check its existence of.</p>
321+
<dd class="field-odd"><p><strong>rule</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span>) – The name of the rule to check its existence of.</p>
322322
</dd>
323323
<dt class="field-even">Return type<span class="colon">:</span></dt>
324-
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p>
324+
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a></span></p>
325325
</dd>
326326
<dt class="field-odd">Returns<span class="colon">:</span></dt>
327327
<dd class="field-odd"><p>True if the rule exists as either a real rule or an alias in this

Diff for: api/docker_tag_updater.parser.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -233,12 +233,12 @@
233233
<dl class="field-list simple">
234234
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
235235
<dd class="field-odd"><ul class="simple">
236-
<li><p><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The name of the container image, e.g., docker.io/alpine:3.19.1</p></li>
237-
<li><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>default: latest</em>) – The base tag to compare the container image to, e.g., latest, edge, etc.</p></li>
238-
<li><p><strong>rule</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><em>default: default</em>) – The rule used to parse the image tags/versions into a semantic version string for
236+
<li><p><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The name of the container image, e.g., docker.io/alpine:3.19.1</p></li>
237+
<li><p><strong>tag</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>default: latest</em>) – The base tag to compare the container image to, e.g., latest, edge, etc.</p></li>
238+
<li><p><strong>rule</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a><em>, </em><em>default: default</em>) – The rule used to parse the image tags/versions into a semantic version string for
239239
comparison. The available options now are (default, docker.io, docker, lscr,
240240
lscr.io, linuxserver)</p></li>
241-
<li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>default: False</em>) – Specify the verbosity of the inspector function.</p></li>
241+
<li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>default: False</em>) – Specify the verbosity of the inspector function.</p></li>
242242
</ul>
243243
</dd>
244244
</dl>

0 commit comments

Comments
 (0)