Skip to content

Bump mkdocstrings[python] from 0.30.1 to 1.0.0#220

Merged
miaucl merged 1 commit intomainfrom
dependabot/pip/mkdocstrings-python--1.0.0
Dec 5, 2025
Merged

Bump mkdocstrings[python] from 0.30.1 to 1.0.0#220
miaucl merged 1 commit intomainfrom
dependabot/pip/mkdocstrings-python--1.0.0

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot Bot commented on behalf of github Dec 1, 2025

Bumps mkdocstrings[python] from 0.30.1 to 1.0.0.

Release notes

Sourced from mkdocstrings[python]'s releases.

1.0.0

1.0.0 - 2025-11-27

Compare with 0.30.1

Breaking Changes

  • BaseHandler.name: Attribute value was changed: '' -> unset
  • BaseHandler.domain: Attribute value was changed: '' -> unset
  • BaseHandler.fallback_config: Public object was removed
  • BaseHandler.__init__(args): Parameter was removed
  • BaseHandler.__init__(kwargs): Parameter was removed
  • BaseHandler.__init__(theme): Parameter was added as required
  • BaseHandler.__init__(custom_templates): Parameter was added as required
  • BaseHandler.__init__(mdx): Parameter was added as required
  • BaseHandler.__init__(mdx_config): Parameter was added as required
  • BaseHandler.update_env(args): Parameter was removed
  • BaseHandler.update_env(kwargs): Parameter was removed
  • BaseHandler.update_env(config): Parameter was added as required
  • Handlers.get_anchors: Public object was removed (import from mkdocstrings directly)
  • mkdocstrings.plugin: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.loggers: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.inventory: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.extension: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.handlers: Public module was removed (import from mkdocstrings directly)

Code Refactoring

  • Remove deprecated code before v1 (de34044 by Timothée Mazzucotelli).
  • Expect Zensical to pass extension configuration instead of loading it again from YAML (6b73d5a by Timothée Mazzucotelli).
  • Expose the Markdown extension, to make mkdocstrings compatible with Zensical (6de2667 by Timothée Mazzucotelli).
Changelog

Sourced from mkdocstrings[python]'s changelog.

1.0.0 - 2025-11-27

Compare with 0.30.1

Breaking Changes

  • BaseHandler.name: Attribute value was changed: '' -> unset
  • BaseHandler.domain: Attribute value was changed: '' -> unset
  • BaseHandler.fallback_config: Public object was removed
  • BaseHandler.__init__(args): Parameter was removed
  • BaseHandler.__init__(kwargs): Parameter was removed
  • BaseHandler.__init__(theme): Parameter was added as required
  • BaseHandler.__init__(custom_templates): Parameter was added as required
  • BaseHandler.__init__(mdx): Parameter was added as required
  • BaseHandler.__init__(mdx_config): Parameter was added as required
  • BaseHandler.update_env(args): Parameter was removed
  • BaseHandler.update_env(kwargs): Parameter was removed
  • BaseHandler.update_env(config): Parameter was added as required
  • Handlers.get_anchors: Public object was removed (import from mkdocstrings directly)
  • mkdocstrings.plugin: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.loggers: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.inventory: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.extension: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.handlers: Public module was removed (import from mkdocstrings directly)

Code Refactoring

  • Remove deprecated code before v1 (de34044 by Timothée Mazzucotelli).
  • Expect Zensical to pass extension configuration instead of loading it again from YAML (6b73d5a by Timothée Mazzucotelli).
  • Expose the Markdown extension, to make mkdocstrings compatible with Zensical (6de2667 by Timothée Mazzucotelli).
Commits
  • 68760a9 chore: Prepare release 1.0.0
  • de34044 refactor: Remove deprecated code before v1
  • 6b73d5a refactor: Expect Zensical to pass extension configuration instead of loading ...
  • bebbb88 chore: Remove trailing space
  • fc4d588 docs: Announce maintenance mode
  • 6de2667 refactor: Expose the Markdown extension, to make mkdocstrings compatible with...
  • 3076375 chore: Specify encoding when reading file in tests
  • 39fbea1 chore: Update sponsors section in README
  • b8f35c1 chore: Template upgrade
  • 5698963 chore: Template upgrade
  • Additional commits viewable in compare view

Dependabot compatibility score

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)

Bumps [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) from 0.30.1 to 1.0.0.
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.30.1...1.0.0)

---
updated-dependencies:
- dependency-name: mkdocstrings[python]
  dependency-version: 1.0.0
  dependency-type: direct:development
  update-type: version-update:semver-major
...

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 Dec 1, 2025
@dependabot dependabot Bot requested review from miaucl and tr4nt0r as code owners December 1, 2025 23:17
@dependabot dependabot Bot added ♻️ dependencies Pull requests that update a dependency file 🐍 python Pull requests that update Python code labels Dec 1, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.43%. Comparing base (5f0feff) to head (eefcb40).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #220   +/-   ##
=======================================
  Coverage   92.43%   92.43%           
=======================================
  Files           6        6           
  Lines         701      701           
  Branches       30       30           
=======================================
  Hits          648      648           
  Misses         46       46           
  Partials        7        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@miaucl
Copy link
Copy Markdown
Owner

miaucl commented Dec 2, 2025

@tr4nt0r Do you already have updated to v1.0.0 elsewhere?

@tr4nt0r
Copy link
Copy Markdown
Collaborator

tr4nt0r commented Dec 2, 2025

there is a breaking change in the mkdocs.yml, the keyword import is deprecated, that has to be changed first

@miaucl miaucl merged commit 1315de3 into main Dec 5, 2025
37 checks passed
@miaucl miaucl deleted the dependabot/pip/mkdocstrings-python--1.0.0 branch December 5, 2025 12:21
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.

2 participants