Support using environment variables for INHERIT when injecting the mike plugin into mkdocs.yml
v2.1.0
New features
When calling set-default, you can now pass --allow-undefined to set the default to a version that doesn't exist yet
Add global-level -q / --quiet option to suppress warning messages
Add support for handling !relative in mkdocs.yml
Bug fixes
When loading an MkDocs config, mike now runs the startup and shutdown events
v2.0.0
New features
Add support for applying arbitrary properties to documentation versions
Add support for hiding specific versions from the selector when using the default themes
Deploy aliases using symbolic links by default; this can be configured via --alias-type on the command line or alias_type in the mike MkDocs plugin
Avoid creating empty commits by default; if you want empty commits, pass --allow-empty
Look for both mkdocs.yml and mkdocs.yaml configuration files
Support GIT_COMMITTER_(NAME|EMAIL|DATE) when generating commits
Allow specifying alias_type, redirect_template, and deploy_prefix in the mike MkDocs plugin
Add a --debug flag to help diagnose bugs with mike
Port number is now optional for --dev-addr in mike serve, defaulting to 8000
Breaking changes
--prefix is now --deploy-prefix
--no-redirect is now --alias-type=copy
--ignore is now --ignore-remote-status
-f / --force 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)
--rebase is no longer supported (instead of using this, it's better to use Git to resolve any conflicts)
Bug fixes
Aliases that are "similar" to preexisting versions (e.g. 1.0 and 1.0.0) can now be set properly
Versions that don't start with a digit (or v and then a digit) are now treated separately from other versions: they're considered development versions, and thus newer than "ordinary" versions
Fix retrieval of Git user name/email when using non-UTF8 encodings
Fix version selector for mkdocs and readthedocs themes when use_directory_urls is false
When redirecting to another page, include the ?query
Support using environment variables for INHERIT when injecting the mike
plugin into mkdocs.yml
v2.1.0 (2024-05-01)
New features
When calling set-default, you can now pass --allow-undefined to set the
default to a version that doesn't exist yet
Add global-level -q / --quiet option to suppress warning messages
Add support for handling !relative in mkdocs.yml
Bug fixes
When loading an MkDocs config, mike now runs the startup and shutdown
events
v2.0.0 (2023-11-02)
New features
Add support for applying arbitrary properties to documentation versions
Add support for hiding specific versions from the selector when using the
default themes
Deploy aliases using symbolic links by default; this can be configured via
--alias-type on the command line or alias_type in the mike MkDocs plugin
Avoid creating empty commits by default; if you want empty commits, pass
--allow-empty
Look for both mkdocs.yml and mkdocs.yaml configuration files
Support GIT_COMMITTER_(NAME|EMAIL|DATE) when generating commits
Allow specifying alias_type, redirect_template, and deploy_prefix in the
mike MkDocs plugin
Add a --debug flag to help diagnose bugs with mike
Port number is now optional for --dev-addr in mike serve, defaulting to
8000
Breaking changes
--prefix is now --deploy-prefix
--no-redirect is now --alias-type=copy
--ignore is now --ignore-remote-status
-f / --force 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)
--rebase is no longer supported (instead of using this, it's better to use
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 commands and options
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 ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore 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 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 ` 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 ` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore ` will remove the ignore condition of the specified dependency and ignore conditions
Bumps the docs group with 2 updates in the /docs directory: mike and mkdocs-material.
Updates
mike
from 1.1.2 to 2.1.1Release notes
Sourced from mike's releases.
Changelog
Sourced from mike's changelog.
... (truncated)
Commits
0bdfe24
Update version to 2.1.13351d5f
Expand environment variables when injecting the mike plugin; resolves #217e4d83ed
Update version to 2.2.0.dev06e6cfbb
Update version to 2.1.05773be9
Fix CI7904925
Further tests for deserializing Python objects duringinject_plugin
01219bd
Allow arbitrary Python object in YAML configac7b240
Handle!relative
(and any future constructors) in mkdocs.yml; resolves #199fdcc912
Add--quiet
option; resolves #210a39ea73
Addset-default --allow-undefined
; see #210Updates
mkdocs-material
from 9.4.6 to 9.5.25Release notes
Sourced from mkdocs-material's releases.
... (truncated)
Changelog
Sourced from mkdocs-material's changelog.
... (truncated)
Commits
c8ee11f
Prepare 9.5.25 release0ee1110
Updated dependencies09f817d
Documentation86d3729
Created new and better Insiders documentation (#7210)1b346eb
Fixed tags plugin crashing on numeric tags05af898
Added --force-reinstall to insiders upgrade instructions (#7203)7368c7f
Updated Insiders changeloge8478d9
Documentationd0be598
Updated Insiders changelog721eefb
Updated Insiders changelogDependabot 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 commands and options
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