Skip to content

Commit

Permalink
Deployed 6f2448a with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Aug 6, 2024
1 parent d4c80a1 commit 2cde939
Show file tree
Hide file tree
Showing 31 changed files with 123 additions and 34 deletions.
Binary file modified objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion reference/api/SUMMARY/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1976,7 +1976,7 @@ <h1>SUMMARY</h1>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/aliases/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2175,7 +2175,7 @@ <h2 id="bumpversion.aliases-functions">Functions<a href="#bumpversion.aliases-fu
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/autocast/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2277,7 +2277,7 @@ <h3 id="bumpversion.autocast.noneify" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
6 changes: 3 additions & 3 deletions reference/api/bumpversion/bump/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2098,7 +2098,7 @@ <h3 id="bumpversion.bump.commit_and_tag" class="doc doc-heading">
<span class="n">config</span><span class="p">:</span> <span class="n">Config</span><span class="p">,</span>
<span class="n">config_file</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">],</span>
<span class="n">configured_files</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">ConfiguredFile</span><span class="p">],</span>
<span class="n">ctx</span><span class="p">:</span> <span class="n">ChainMap</span><span class="p">,</span>
<span class="n">ctx</span><span class="p">:</span> <span class="n">MutableMapping</span><span class="p">,</span>
<span class="n">dry_run</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>
Expand Down Expand Up @@ -2145,7 +2145,7 @@ <h3 id="bumpversion.bump.commit_and_tag" class="doc doc-heading">
</div>
<p class="doc-param-annotation">
<span class="doc-param-key">TYPE:</span>
<code><a class="autorefs autorefs-external" title="typing.ChainMap" href="https://docs.python.org/3/library/typing.html#typing.ChainMap">ChainMap</a></code>
<code><a class="autorefs autorefs-external" title="typing.MutableMapping" href="https://docs.python.org/3/library/typing.html#typing.MutableMapping">MutableMapping</a></code>
</p> </dd>
<dt class="doc-field-term"><code>dry_run</code></dt>
<dd class="doc-field-def">
Expand Down Expand Up @@ -2370,7 +2370,7 @@ <h3 id="bumpversion.bump.get_next_version" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/cli/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2322,7 +2322,7 @@ <h3 id="bumpversion.cli.show_bump" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/create/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2179,7 +2179,7 @@ <h3 id="bumpversion.config.create.get_defaults_from_dest" class="doc doc-heading
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/files/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2381,7 +2381,7 @@ <h3 id="bumpversion.config.files.update_config_file" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/files_legacy/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2223,7 +2223,7 @@ <h3 id="bumpversion.config.files_legacy.update_ini_config_file" class="doc doc-h
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2174,7 +2174,7 @@ <h3 id="bumpversion.config.set_config_defaults" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/models/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2364,7 +2364,7 @@ <h2 id="bumpversion.config.models-functions">Functions<a href="#bumpversion.conf
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/config/utils/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2207,7 +2207,7 @@ <h3 id="bumpversion.config.utils.resolve_glob_files" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/context/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2232,7 +2232,7 @@ <h3 id="bumpversion.context.prefixed_environ" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/exceptions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2534,7 +2534,7 @@ <h3 id="bumpversion.exceptions.VersionNotFoundError" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/files/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2677,7 +2677,7 @@ <h3 id="bumpversion.files.resolve_file_config" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/indented_logger/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2359,7 +2359,7 @@ <h5 id="bumpversion.indented_logger.IndentedLoggerAdapter.reset" class="doc doc-
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1985,7 +1985,7 @@ <h1>Index</h1>
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
26 changes: 23 additions & 3 deletions reference/api/bumpversion/scm/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2234,7 +2234,7 @@ <h5 id="bumpversion.scm.Git.tag" class="doc doc-heading">

<p>Create a tag of the new_version in VCS.</p>
<p>If only name is given, bumpversion uses a lightweight tag.
Otherwise, it utilizes an annotated tag.</p>
Otherwise, it uses an annotated tag.</p>



Expand Down Expand Up @@ -2412,7 +2412,7 @@ <h5 id="bumpversion.scm.Mercurial.tag" class="doc doc-heading">

<p>Create a tag of the new_version in VCS.</p>
<p>If only name is given, bumpversion uses a lightweight tag.
Otherwise, it utilizes an annotated tag.</p>
Otherwise, it uses an annotated tag.</p>



Expand Down Expand Up @@ -2499,6 +2499,7 @@ <h3 id="bumpversion.scm.SCMInfo" class="doc doc-heading">
<span class="n">current_version</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">branch_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">short_branch_name</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">repository_root</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">dirty</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span>
</code></pre></div>
Expand All @@ -2519,7 +2520,26 @@ <h3 id="bumpversion.scm.SCMInfo" class="doc doc-heading">



<h4 id="bumpversion.scm.SCMInfo-functions">Functions<a href="#bumpversion.scm.SCMInfo-functions" class="headerlink" title="Permanent link">&para;</a></h4>

<div class="doc doc-object doc-function">


<h5 id="bumpversion.scm.SCMInfo.path_in_repo" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">path_in_repo</span>


<a href="#bumpversion.scm.SCMInfo.path_in_repo" class="headerlink" title="Permanent link">&para;</a></h5>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">path_in_repo</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="nb">bool</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Return whether a path is inside this repository.</p>

</div>

</div>



Expand Down Expand Up @@ -2891,7 +2911,7 @@ <h3 id="bumpversion.scm.get_scm_info" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/show/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2322,7 +2322,7 @@ <h4 id="bumpversion.show.resolve_name--noqa-dar401">noqa: DAR401<a class="header
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
2 changes: 1 addition & 1 deletion reference/api/bumpversion/ui/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2226,7 +2226,7 @@ <h3 id="bumpversion.ui.setup_logging" class="doc doc-heading">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 4, 2024</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 6, 2024</span>
</span>


Expand Down
Loading

0 comments on commit 2cde939

Please sign in to comment.