Skip to content

Commit 11abefd

Browse files
Bump mike from 1.1.2 to 2.0.0 (#109)
Bumps [mike](https://github.com/jimporter/mike) from 1.1.2 to 2.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/jimporter/mike/releases">mike's releases</a>.</em></p> <blockquote> <h2>v2.0.0</h2> <h3>New features</h3> <ul> <li>Add support for applying arbitrary properties to documentation versions</li> <li>Add support for hiding specific versions from the selector when using the default themes</li> <li>Deploy aliases using symbolic links by default; this can be configured via <code>--alias-type</code> on the command line or <code>alias_type</code> in the <code>mike</code> MkDocs plugin</li> <li>Avoid creating empty commits by default; if you want empty commits, pass <code>--allow-empty</code></li> <li>Look for both <code>mkdocs.yml</code> and <code>mkdocs.yaml</code> configuration files</li> <li>Support <code>GIT_COMMITTER_(NAME|EMAIL|DATE)</code> when generating commits</li> <li>Allow specifying <code>alias_type</code>, <code>redirect_template</code>, and <code>deploy_prefix</code> in the <code>mike</code> MkDocs plugin</li> <li>Add a <code>--debug</code> flag to help diagnose bugs with mike</li> <li>Port number is now optional for <code>--dev-addr</code> in <code>mike serve</code>, defaulting to 8000</li> </ul> <h3>Breaking changes</h3> <ul> <li><code>--prefix</code> is now <code>--deploy-prefix</code></li> <li><code>--no-redirect</code> is now <code>--alias-type=copy</code></li> <li><code>--ignore</code> is now <code>--ignore-remote-status</code></li> <li><code>-f</code> / <code>--force</code> is no longer supported on subcommands that can push (this option was too error-prone, and users who really need to force-push can use Git directly)</li> <li><code>--rebase</code> is no longer supported (instead of using this, it's better to use Git to resolve any conflicts)</li> </ul> <h3>Bug fixes</h3> <ul> <li>Aliases that are &quot;similar&quot; to preexisting versions (e.g. <code>1.0</code> and <code>1.0.0</code>) can now be set properly</li> <li>Versions that <em>don't</em> start with a digit (or <code>v</code> and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than &quot;ordinary&quot; versions</li> <li>Fix retrieval of Git user name/email when using non-UTF8 encodings</li> <li>Fix version selector for <code>mkdocs</code> and <code>readthedocs</code> themes when <code>use_directory_urls</code> is false</li> <li>When redirecting to another page, include the <code>?query</code></li> <li>Ensure that aliases cannot be circularly defined</li> <li>Support file names with double-quotes or newlines</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/jimporter/mike/blob/master/CHANGES.md">mike's changelog</a>.</em></p> <blockquote> <h2>v2.0.0 (2023-11-02)</h2> <h3>New features</h3> <ul> <li>Add support for applying arbitrary properties to documentation versions</li> <li>Add support for hiding specific versions from the selector when using the default themes</li> <li>Deploy aliases using symbolic links by default; this can be configured via <code>--alias-type</code> on the command line or <code>alias_type</code> in the <code>mike</code> MkDocs plugin</li> <li>Avoid creating empty commits by default; if you want empty commits, pass <code>--allow-empty</code></li> <li>Look for both <code>mkdocs.yml</code> and <code>mkdocs.yaml</code> configuration files</li> <li>Support <code>GIT_COMMITTER_(NAME|EMAIL|DATE)</code> when generating commits</li> <li>Allow specifying <code>alias_type</code>, <code>redirect_template</code>, and <code>deploy_prefix</code> in the <code>mike</code> MkDocs plugin</li> <li>Add a <code>--debug</code> flag to help diagnose bugs with mike</li> <li>Port number is now optional for <code>--dev-addr</code> in <code>mike serve</code>, defaulting to 8000</li> </ul> <h3>Breaking changes</h3> <ul> <li><code>--prefix</code> is now <code>--deploy-prefix</code></li> <li><code>--no-redirect</code> is now <code>--alias-type=copy</code></li> <li><code>--ignore</code> is now <code>--ignore-remote-status</code></li> <li><code>-f</code> / <code>--force</code> is no longer supported on subcommands that can push (this option was too error-prone, and users who really need to force-push can use Git directly)</li> <li><code>--rebase</code> is no longer supported (instead of using this, it's better to use Git to resolve any conflicts)</li> </ul> <h3>Bug fixes</h3> <ul> <li>Aliases that are &quot;similar&quot; to preexisting versions (e.g. <code>1.0</code> and <code>1.0.0</code>) can now be set properly</li> <li>Versions that <em>don't</em> start with a digit (or <code>v</code> and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than &quot;ordinary&quot; versions</li> <li>Fix retrieval of Git user name/email when using non-UTF8 encodings</li> <li>Fix version selector for <code>mkdocs</code> and <code>readthedocs</code> themes when <code>use_directory_urls</code> is false</li> <li>When redirecting to another page, include the <code>?query</code></li> <li>Ensure that aliases cannot be circularly defined</li> <li>Support file names with double-quotes or newlines</li> </ul> <hr /> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/jimporter/mike/commit/44cc579296327da713a18f93ea5e4fa5a6e8a715"><code>44cc579</code></a> Update version to 2.0.0</li> <li><a href="https://github.com/jimporter/mike/commit/f9af52d5ea3fff5327e3947e378bae8f6b80f61a"><code>f9af52d</code></a> Yet more typos</li> <li><a href="https://github.com/jimporter/mike/commit/8b4281c30cc980c16d8c40a301cde6800fdbe2bb"><code>8b4281c</code></a> Fix invalid JSONPath syntax example</li> <li><a href="https://github.com/jimporter/mike/commit/875bf58f845f126a4ac22f1dba0cc5b0c899ab63"><code>875bf58</code></a> More typos</li> <li><a href="https://github.com/jimporter/mike/commit/7a55bf314e739ab5256e7c2493ddf7bbec08e9a9"><code>7a55bf3</code></a> Typo</li> <li><a href="https://github.com/jimporter/mike/commit/0481f9293adfd66452d43a5c9dd3e9d8c48344bd"><code>0481f92</code></a> Allow new versions to replace existing aliases when <code>--update-aliases</code> is set</li> <li><a href="https://github.com/jimporter/mike/commit/6de61fa1d344d28a8570d008532c6a12943cb861"><code>6de61fa</code></a> Fix poor wording in changes</li> <li><a href="https://github.com/jimporter/mike/commit/367fbd009abfaa38a62aed6ecebb73f50d218e47"><code>367fbd0</code></a> Add support for hidden versions in the built-in themes; resolves <a href="https://redirect.github.com/jimporter/mike/issues/187">#187</a></li> <li><a href="https://github.com/jimporter/mike/commit/c69d11faa8c1f7e0fe81d4bd8bbcf9e7035c5abd"><code>c69d11f</code></a> Allow setting arbitrary properties for versions; resolves <a href="https://redirect.github.com/jimporter/mike/issues/138">#138</a></li> <li><a href="https://github.com/jimporter/mike/commit/27e7cba3e2a475232d06ea53c1fa7eeb872aa62c"><code>27e7cba</code></a> Add properties to VersionInfo</li> <li>Additional commits viewable in <a href="https://github.com/jimporter/mike/compare/v1.1.2...v2.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mike&package-manager=pip&previous-version=1.1.2&new-version=2.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details>
2 parents c693227 + 614afb4 commit 11abefd

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ dev-flake8 = [
4646
]
4747
dev-formatting = ["black == 23.9.1", "isort == 5.12.0"]
4848
dev-mkdocs = [
49-
"mike == 1.1.2",
49+
"mike == 2.0.0",
5050
"mkdocs-gen-files == 0.5.0",
5151
"mkdocs-literate-nav == 0.6.1",
5252
"mkdocs-material == 9.4.3",

0 commit comments

Comments
 (0)