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.

Sign up for GitHub

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

Jump to bottom

Bump the docs group with 2 updates #144

Merged
merged 1 commit into from
Mar 1, 2025
Merged

Bump the docs group with 2 updates #144

merged 1 commit into from
Mar 1, 2025
+14 −15

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 1, 2025

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

Updates mkdocstrings from 0.27.0 to 0.28.2

Release notes

Sourced from mkdocstrings's releases.

0.28.2

0.28.2 - 2025-02-24

Compare with 0.28.1

Build

  • Depend on mkdocs-autorefs >= 1.4 (2c22bdc by Timothée Mazzucotelli).

0.28.1

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

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

... (truncated)

Changelog

Sourced from mkdocstrings's changelog.

0.28.2 - 2025-02-24

Compare with 0.28.1

Build

  • Depend on mkdocs-autorefs >= 1.4 (2c22bdc by Timothée Mazzucotelli).

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

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

... (truncated)

Commits
  • 2b9b4f0 chore: Prepare release 0.28.2
  • 2c22bdc build: Depend on mkdocs-autorefs >= 1.4
  • 145954c chore: Prepare release 0.28.1
  • 4ab180d fix: Renew MkDocs' relpath processor instead of using same instance
  • ede1941 chore: Increase mkdocstrings-python lower bound again
  • e1eb99c docs: Use inventories instead of import for Python example
  • 926dd7e docs: Remove trailing spaces
  • 698a321 chore: Update mkdocstrings-python dev-dep to force uv to install it
  • 1cb9177 chore: Update location of the Python handler's JSON schema
  • 6ef1412 chore: Prepare release 0.28.0
  • Additional commits viewable in compare view

Updates mkdocs-material from 9.6.1 to 9.6.5

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.6.5

  • Fixed #8016: Tags listing not showing when when file name has spaces
  • Fixed #8012: Privacy plugin crashes if HTTP download fails

mkdocs-material-9.6.4

  • Fixed #7985: Blog content sometimes not stretching to full width
  • Fixed #7978: Navigation rendering bug in Safari 18.3

mkdocs-material-9.6.3

  • Fixed rendering of arrow heads in Mermaid.js class diagrams
  • Fixed #7960: Tags plugin crashes on numeric metadata titles

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
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.6.5 (2025-02-20)

  • Fixed #8016: Tags listing not showing when when file name has spaces
  • Fixed #8012: Privacy plugin crashes if HTTP download fails

mkdocs-material-9.6.4 (2025-02-12)

  • Fixed #7985: Blog content sometimes not stretching to full width
  • Fixed #7978: Navigation rendering bug in Safari 18.3

mkdocs-material-9.6.3 (2025-02-07)

  • Fixed rendering of arrow heads in Mermaid.js class diagrams
  • Fixed #7960: Tags plugin crashes on numeric metadata titles

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)

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

@dependabot
Bump the docs group with 2 updates
5ffbf14 
Bumps the docs group with 2 updates: [mkdocstrings](/~https://github.com/mkdocstrings/mkdocstrings) and [mkdocs-material](/~https://github.com/squidfunk/mkdocs-material).


Updates `mkdocstrings` from 0.27.0 to 0.28.2
- [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.2)

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

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Mar 1, 2025
@insolor insolor merged commit 385a76f into main Mar 1, 2025
5 checks passed
@insolor insolor deleted the dependabot/pip/docs-7be3e97590 branch March 1, 2025 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
dependencies Pull requests that update a dependency file python Pull requests that update Python code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@insolor