Skip to content

Commit 2920576

Browse files
authored
Bump mkdocstrings[python] from 0.30.1 to 1.0.0 (#217)
Bumps [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) from 0.30.1 to 1.0.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/mkdocstrings/releases">mkdocstrings[python]'s releases</a>.</em></p> <blockquote> <h2>1.0.0</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.0">1.0.0</a> - 2025-11-27</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.30.1...1.0.0">Compare with 0.30.1</a><!-- raw HTML omitted --></p> <h3>Breaking Changes</h3> <ul> <li><code>BaseHandler.name</code>: <em>Attribute value was changed</em>: <code>''</code> -&gt; unset</li> <li><code>BaseHandler.domain</code>: <em>Attribute value was changed</em>: <code>''</code> -&gt; unset</li> <li><code>BaseHandler.fallback_config</code>: <em>Public object was removed</em></li> <li><code>BaseHandler.__init__(args)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.__init__(kwargs)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.__init__(theme)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(custom_templates)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(mdx)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(mdx_config)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.update_env(args)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.update_env(kwargs)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.update_env(config)</code>: <em>Parameter was added as required</em></li> <li><code>Handlers.get_anchors</code>: <em>Public object was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.plugin</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.loggers</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.inventory</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.extension</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.handlers</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Remove deprecated code before v1 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/de34044a02b45250e215af0f969dca581dfb82c5">de34044</a> by Timothée Mazzucotelli).</li> <li>Expect Zensical to pass extension configuration instead of loading it again from YAML (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/6b73d5a2f455062ab6c68376c85adce6adc037a3">6b73d5a</a> by Timothée Mazzucotelli).</li> <li>Expose the Markdown extension, to make mkdocstrings compatible with Zensical (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/6de266759b79eb72cddd300e6a0a8576085fae40">6de2667</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md">mkdocstrings[python]'s changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.0">1.0.0</a> - 2025-11-27</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.30.1...1.0.0">Compare with 0.30.1</a><!-- raw HTML omitted --></p> <h3>Breaking Changes</h3> <ul> <li><code>BaseHandler.name</code>: <em>Attribute value was changed</em>: <code>''</code> -&gt; unset</li> <li><code>BaseHandler.domain</code>: <em>Attribute value was changed</em>: <code>''</code> -&gt; unset</li> <li><code>BaseHandler.fallback_config</code>: <em>Public object was removed</em></li> <li><code>BaseHandler.__init__(args)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.__init__(kwargs)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.__init__(theme)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(custom_templates)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(mdx)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.__init__(mdx_config)</code>: <em>Parameter was added as required</em></li> <li><code>BaseHandler.update_env(args)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.update_env(kwargs)</code>: <em>Parameter was removed</em></li> <li><code>BaseHandler.update_env(config)</code>: <em>Parameter was added as required</em></li> <li><code>Handlers.get_anchors</code>: <em>Public object was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.plugin</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.loggers</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.inventory</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.extension</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> <li><code>mkdocstrings.handlers</code>: <em>Public module was removed</em> (import from <code>mkdocstrings</code> directly)</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Remove deprecated code before v1 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/de34044a02b45250e215af0f969dca581dfb82c5">de34044</a> by Timothée Mazzucotelli).</li> <li>Expect Zensical to pass extension configuration instead of loading it again from YAML (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/6b73d5a2f455062ab6c68376c85adce6adc037a3">6b73d5a</a> by Timothée Mazzucotelli).</li> <li>Expose the Markdown extension, to make mkdocstrings compatible with Zensical (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/6de266759b79eb72cddd300e6a0a8576085fae40">6de2667</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/68760a9ec55772c8b330b056c2d0896877324b1c"><code>68760a9</code></a> chore: Prepare release 1.0.0</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/de34044a02b45250e215af0f969dca581dfb82c5"><code>de34044</code></a> refactor: Remove deprecated code before v1</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/6b73d5a2f455062ab6c68376c85adce6adc037a3"><code>6b73d5a</code></a> refactor: Expect Zensical to pass extension configuration instead of loading ...</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/bebbb88d3f09249b0129b05f98fdbd9f2eaa6818"><code>bebbb88</code></a> chore: Remove trailing space</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/fc4d588dc73b12c205a933a0a5808742119aa7d3"><code>fc4d588</code></a> docs: Announce maintenance mode</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/6de266759b79eb72cddd300e6a0a8576085fae40"><code>6de2667</code></a> refactor: Expose the Markdown extension, to make mkdocstrings compatible with...</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/3076375ec7eb4c9c8b739e414a919a1be29df07a"><code>3076375</code></a> chore: Specify encoding when reading file in tests</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/39fbea1c2dd030f017ae6fd4a8653959f310a693"><code>39fbea1</code></a> chore: Update sponsors section in README</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/b8f35c14f1b93408096cd2289782159beb0cdf03"><code>b8f35c1</code></a> chore: Template upgrade</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/5698963317af8e5d790a558fd945371f6ef3811a"><code>5698963</code></a> chore: Template upgrade</li> <li>Additional commits viewable in <a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.30.1...1.0.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocstrings[python]&package-manager=pip&previous-version=0.30.1&new-version=1.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 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-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> 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) </details>
2 parents 8d834da + 5dd4c05 commit 2920576

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ dev-mkdocs = [
6969
"mkdocs-literate-nav == 0.6.2",
7070
"mkdocs-macros-plugin == 1.4.1",
7171
"mkdocs-material == 9.6.22",
72-
"mkdocstrings[python] == 0.30.1",
72+
"mkdocstrings[python] == 1.0.0",
7373
"mkdocstrings-python == 1.18.2",
7474
"frequenz-repo-config[lib] == 0.13.7",
7575
]

0 commit comments

Comments
 (0)