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 mkdocs group with 2 updates #677

Merged
merged 1 commit into from
Feb 3, 2025

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 3, 2025

Bumps the mkdocs group with 2 updates: mkdocs-material and mkdocstrings.

Updates mkdocs-material from 9.5.50 to 9.6.2

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.6.2

  • Fixed #7955: Excessively long words don't break on narrow screens
  • Fixed #7947: Scope setting interferes with outdated version banner

mkdocs-material-9.6.1

  • Fixed #7943: Tags plugin crashing due to merge error

mkdocs-material-9.6.0

  • Added meta plugin
  • Rewrite of the tags plugin
  • Added support for allow lists in tags plugin
  • Added support for and custom sorting in tags plugin
  • Added support for related links in blog plugin
  • Added support for custom index pages in blog plugin
  • Added support for navigation subtitles
  • Fixed #7924: Anchors might require two clicks when using instant navigation
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.6.2 (2025-02-03)

  • Fixed #7955: Excessively long words don't break on narrow screens
  • Fixed #7947: Scope setting interferes with outdated version banner

mkdocs-material-9.6.1 (2025-01-31)

  • Fixed #7943: Tags plugin crashing due to merge error

mkdocs-material-9.6.0 (2025-01-31)

  • Added meta plugin
  • Rewrite of the tags plugin
  • Added support for allow lists in tags plugin
  • Added support for and custom sorting in tags plugin
  • Added support for related links in blog plugin
  • Added support for custom index pages in blog plugin
  • Added support for navigation subtitles
  • Fixed #7924: Anchors might require two clicks when using instant navigation

mkdocs-material-9.5.50 (2025-01-18)

  • Fixed #7913: Social plugin renders attribute lists in page title

mkdocs-material-9.5.49+insiders-4.53.15 (2025-01-15)

  • Fixed #7896: Scoped tags listings not rendering in subsections

mkdocs-material-9.5.49 (2024-12-16)

  • Adjusted title color in dark mode for all supported Mermaid.js diagrams
  • Fixed #7803: Privacy plugin crashes on generated files
  • Fixed #7781: Mermaid.js flow chart title not visible in dark mode

mkdocs-material-9.5.48 (2024-12-08)

  • Fixed #7774: Disabling social cards doesn't work

mkdocs-material-9.5.47 (2024-12-01)

  • Fixed #7750: Numeric tags break search
  • Fixed #7748: Blog plugin breaks when using future drafts (9.5.45 regression)

mkdocs-material-9.5.46 (2024-11-25)

  • Added support for removing preload hints in privacy plugin
  • Fixed #7734: Code blocks in h5 headlines are uppercased
  • Fixed #7725: Blog plugin crashing on missing timezone (9.5.45 regression)

mkdocs-material-9.5.45 (2024-11-20)

... (truncated)

Commits

Updates mkdocstrings from 0.27.0 to 0.28.0

Release notes

Sourced from mkdocstrings's releases.

0.28.0

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

Changelog

Sourced from mkdocstrings's changelog.

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

class MyHandler:
    name = "myhandler"

The domain attribute must be specified as a class attribute.

The domain class attribute on handlers is now mandatory and cannot be an empty string.

... (truncated)

Commits
  • 6ef1412 chore: Prepare release 0.28.0
  • 936275e Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 3cf7d51 fix: Update handlers in JSON schema to be an object instead of an array
  • f3ecf58 chore: Ignore autorefs fallback deprecation warning
  • 9618e17 docs: Mention mkdocs-api-autonav in recipe
  • 52ea2f2 ci: Upgrade dev-deps to prevent warnings in tests
  • 8c476ee refactor: Pass config_file_path to get_handler if it expects it
  • 053ef23 Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 48625a2 chore: Fix inventory loading error log message
  • 060e437 docs: Fix link to arithmatex docs in Material for MkDocs
  • Additional commits viewable in compare view

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 mkdocs group with 2 updates: [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings).


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

Updates `mkdocstrings` from 0.27.0 to 0.28.0
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.27.0...0.28.0)

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

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 Feb 3, 2025
@ahouseholder ahouseholder merged commit fce5b70 into main Feb 3, 2025
3 checks passed
@ahouseholder ahouseholder deleted the dependabot/pip/mkdocs-4fae5ebf57 branch February 3, 2025 20:45
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.

1 participant