Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump the docs group across 1 directory with 2 updates #639

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jun 1, 2024

Bumps the docs group with 2 updates in the /docs directory: mike and mkdocs-material.

Updates mike from 1.1.2 to 2.1.1

Release notes

Sourced from mike's releases.

v2.1.1

Bug fixes

  • 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
  • Ensure that aliases cannot be circularly defined
  • Support file names with double-quotes or newlines
Changelog

Sourced from mike's changelog.

v2.1.1 (2024-05-03)

Bug fixes

  • 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

... (truncated)

Commits
  • 0bdfe24 Update version to 2.1.1
  • 3351d5f Expand environment variables when injecting the mike plugin; resolves #217
  • e4d83ed Update version to 2.2.0.dev0
  • 6e6cfbb Update version to 2.1.0
  • 5773be9 Fix CI
  • 7904925 Further tests for deserializing Python objects during inject_plugin
  • 01219bd Allow arbitrary Python object in YAML config
  • ac7b240 Handle !relative (and any future constructors) in mkdocs.yml; resolves #199
  • fdcc912 Add --quiet option; resolves #210
  • a39ea73 Add set-default --allow-undefined; see #210
  • Additional commits viewable in compare view

Updates mkdocs-material from 9.4.6 to 9.5.25

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.5.25

  • Fixed #7209: Tags plugin crashing on numeric tags

mkdocs-material-9.5.24

  • Fixed #7187: Version selector title rendering issue

mkdocs-material-9.5.23

  • Fixed #7183: Edge case in anchor navigation when using instant navigation
  • Fixed #6436: Version selector not showing version alias

mkdocs-material-9.5.22

  • Fixed #7170: Copy button adds empty lines for line spans (9.5.18 regression)
  • Fixed #7160: Version switching doesn't stay on page (9.5.5 regression)
  • Fixed #5619: Links in Mermaid.js diagrams not discernible

mkdocs-material-9.5.21

  • Fixed #7133: Ensure latest version of Mermaid.js is used
  • Fixed #7125: Added warning for dotfiles in info plugin

Thanks to @​kamilkrzyskow for their contributions

mkdocs-material-9.5.20

  • Fixed deprecation warning in privacy plugin (9.5.19 regression)
  • Fixed #7119: Tags plugin emits deprecation warning (9.5.19 regression)
  • Fixed #7118: Social plugin crashes if fonts are disabled (9.5.19 regression)
  • Fixed #7085: Social plugin crashes on Windows when downloading fonts

mkdocs-material-9.5.19

  • Updated MkDocs to 1.6 and limited version to < 2
  • Updated Docker image to latest Alpine Linux
  • Removed setup.py, now that GitHub fully understands pyproject.toml
  • Improved interop of social plugin with third-party MkDocs themes
  • Fixed #7099: Blog reading time not rendered correctly for Japanese
  • Fixed #7097: Improved resilience of tags plugin when no tags are given
  • Fixed #7090: Active tab indicator in nested content tabs rendering bug

mkdocs-material-9.5.18

  • Refactored tooltips implementation to fix positioning issues
  • Fixed #7044: Rendering glitch when hovering contributor avatar in Chrome
  • Fixed #7043: Highlighted lines in code blocks cutoff on mobile
  • Fixed #6910: Incorrect position of tooltip for page status in sidebar
  • Fixed #6760: Incorrect position and overly long tooltip in tables
  • Fixed #6488: Incorrect position and cutoff tooltip in content tabs

mkdocs-material-9.5.17

  • Updated Serbian translations
  • Fixed #7003: Confusing keyboard interaction for palette toggle
  • Fixed #7001: Blog posts now show time by default (9.5.16 regression)
  • Fixed edge case in backport of social plugin font loading logic

... (truncated)

Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.5.25+insiders-4.53.11 (2024-05-27)

  • Fixed projects plugin crashing when serving before building subprojects

mkdocs-material-9.5.25 (2024-05-27)

  • Fixed #7209: Tags plugin crashing on numeric tags

mkdocs-material-9.5.24+insiders-4.53.10 (2024-05-20)

  • Fixed projects plugin crashing in serve mode when disabled
  • Fixed projects plugin crashing when building nested projects

mkdocs-material-9.5.24+insiders-4.53.9 (2024-05-20)

  • Fixed #7191: Tags listings not rendering when toc_depth is changed

mkdocs-material-9.5.24 (2024-05-20)

  • Fixed #7187: Version selector title rendering issue

mkdocs-material-9.5.23 (2024-05-15)

  • Fixed #7183: Edge case in anchor navigation when using instant navigation
  • Fixed #6436: Version selector not showing version alias

mkdocs-material-9.5.22 (2024-05-12)

  • Fixed #7170: Copy button adds empty lines for line spans (9.5.18 regression)
  • Fixed #7160: Version switching doesn't stay on page (9.5.5 regression)
  • Fixed #5619: Links in Mermaid.js diagrams not discernible

mkdocs-material-9.5.21 (2024-05-03)

  • Fixed #7133: Ensure latest version of Mermaid.js is used
  • Fixed #7125: Added warning for dotfiles in info plugin

mkdocs-material-9.5.20 (2024-04-29)

  • Fixed deprecation warning in privacy plugin (9.5.19 regression)
  • Fixed #7119: Tags plugin emits deprecation warning (9.5.19 regression)
  • Fixed #7118: Social plugin crashes if fonts are disabled (9.5.19 regression)
  • Fixed #7085: Social plugin crashes on Windows when downloading fonts

mkdocs-material-9.5.19+insiders-4.53.8 (2024-04-26)

  • Fixed #7052: Preview extension automatically including all pages
  • Fixed #7051: Instant previews mounting on footnote references
  • Fixed #5165: Improved tooltips not mounting in sidebar for typeset plugin

... (truncated)

Commits

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 <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

Bumps the docs group with 2 updates in the /docs directory: [mike](https://github.com/jimporter/mike) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mike` from 1.1.2 to 2.1.1
- [Release notes](https://github.com/jimporter/mike/releases)
- [Changelog](https://github.com/jimporter/mike/blob/master/CHANGES.md)
- [Commits](jimporter/mike@v1.1.2...v2.1.1)

Updates `mkdocs-material` from 9.4.6 to 9.5.25
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.4.6...9.5.25)

---
updated-dependencies:
- dependency-name: mike
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: docs
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: docs
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants