Bump mkdocstrings[python] from 0.27.0 to 0.28.1

[dependabot]

Bumps mkdocstrings[python] from 0.27.0 to 0.28.1.

Release notes

Sourced from mkdocstrings[python]'s releases.

0.28.1

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

• Renew MkDocs' relpath processor instead of using same instance (4ab180d by Timothée Mazzucotelli). Issue-mkdocs-3919

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.

... (truncated)

Changelog

Sourced from mkdocstrings[python]'s changelog.

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

• Renew MkDocs' relpath processor instead of using same instance (4ab180d by Timothée Mazzucotelli). Issue-mkdocs-3919

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.

</tr></table> 

... (truncated)

Commits

• 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
• 936275e Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
• 3cf7d51 fix: Update handlers in JSON schema to be an object instead of an array
• 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 this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the mkdocstrings[python] dependency from version 0.27.0 to 0.28.1, incorporating bug fixes and breaking changes in the library's API.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Update mkdocstrings[python] dependency version.	Bump mkdocstrings[python] from version 0.27.0 to 0.28.1 in the dev_requirements.txt file.	dev_requirements.txt

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

We have skipped reviewing this pull request. It seems to have been created by a bot (hey, dependabot[bot]!). We assume it knows what it's doing!

[dependabot]

Superseded by #426.