Skip to content

Conversation

@dependabot
Copy link
Contributor

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

Updates the requirements on mkdocstrings[python] to permit the latest version.

Release notes

Sourced from mkdocstrings[python]'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).
Changelog

Sourced from mkdocstrings[python]'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

You can trigger a rebase of this PR 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)

📚 Documentation preview 📚: https://pytorch-tabular--550.org.readthedocs.build/en/550/

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

Updates the requirements on [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) to permit the latest version.
- [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)

---
updated-dependencies:
- dependency-name: mkdocstrings[python]
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Mar 1, 2025
@dependabot dependabot bot requested a review from manujosephv March 1, 2025 11:17
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 1, 2025
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Apr 1, 2025

Superseded by #559.

@dependabot dependabot bot closed this Apr 1, 2025
@dependabot dependabot bot deleted the dependabot-pip-mkdocstrings-python--eq-0.28.star branch April 1, 2025 11:38
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 size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant