Skip to content

Commit 8d41bb6

Browse files
authored
Bump mkdocstrings[python] from 0.22.0 to 0.23.0 (#167)
Bumps [mkdocstrings[python]](https://github.com/mkdocstrings/mkdocstrings) from 0.22.0 to 0.23.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>0.23.0</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.23.0">0.23.0</a> - 2023-08-28</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.22.0...0.23.0">Compare with 0.22.0</a><!-- raw HTML omitted --></p> <h3>Breaking Changes</h3> <ul> <li>Removed <code>BaseCollector</code> and <code>BaseRenderer</code> classes: they were merged into the <code>BaseHandler</code> class.</li> <li>Removed the watch feature, as MkDocs now provides it natively.</li> <li>Removed support for <code>selection</code> and <code>rendering</code> keys in YAML blocks: use <code>options</code> instead.</li> <li>Removed support for loading handlers from the <code>mkdocstrings.handler</code> namespace. Handlers must now be packaged under the <code>mkdocstrings_handlers</code> namespace.</li> </ul> <h3>Features</h3> <ul> <li>Register all anchors for each object in the inventory (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/228fb737caca4e20e600053bf59cbfa3e9c73906">228fb73</a> by Timothée Mazzucotelli).</li> </ul> <h3>Bug Fixes</h3> <ul> <li>Don't add <code>codehilite</code> CSS class to inline code (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/7690d41e2871997464367e673023585c4fb05e26">7690d41</a> by Timothée Mazzucotelli).</li> <li>Support cross-references for API docs rendered in top-level index page (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/b194452be93aee33b3c28a468762b4d96c501f4f">b194452</a> by Timothée Mazzucotelli).</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Sort inventories before writing them to disk (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/9371e9fc7dd68506b73aa1580a12c5f5cd779aba">9371e9f</a> by Timothée Mazzucotelli).</li> <li>Stop accepting sets as return value of <code>get_anchors</code> (only tuples), to preserve order (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/2e10374be258e9713b26f73dd06d0c2520ec07a5">2e10374</a> by Timothée Mazzucotelli).</li> <li>Remove deprecated parts (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/0a90a474c8dcbd95821700d7dab63f03e392c40f">0a90a47</a> by Timothée Mazzucotelli).</li> <li>Use proper parameters in <code>Inventory.register</code> method (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/433c6e01aab9333589f755e483f124db0836f143">433c6e0</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/0.23.0">0.23.0</a> - 2023-08-28</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.22.0...0.23.0">Compare with 0.22.0</a><!-- raw HTML omitted --></p> <h3>Breaking Changes</h3> <ul> <li>Removed <code>BaseCollector</code> and <code>BaseRenderer</code> classes: they were merged into the <code>BaseHandler</code> class.</li> <li>Removed the watch feature, as MkDocs now provides it natively.</li> <li>Removed support for <code>selection</code> and <code>rendering</code> keys in YAML blocks: use <code>options</code> instead.</li> <li>Removed support for loading handlers from the <code>mkdocstrings.handler</code> namespace. Handlers must now be packaged under the <code>mkdocstrings_handlers</code> namespace.</li> </ul> <h3>Features</h3> <ul> <li>Register all anchors for each object in the inventory (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/228fb737caca4e20e600053bf59cbfa3e9c73906">228fb73</a> by Timothée Mazzucotelli).</li> </ul> <h3>Bug Fixes</h3> <ul> <li>Don't add <code>codehilite</code> CSS class to inline code (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/7690d41e2871997464367e673023585c4fb05e26">7690d41</a> by Timothée Mazzucotelli).</li> <li>Support cross-references for API docs rendered in top-level index page (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/b194452be93aee33b3c28a468762b4d96c501f4f">b194452</a> by Timothée Mazzucotelli).</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Sort inventories before writing them to disk (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/9371e9fc7dd68506b73aa1580a12c5f5cd779aba">9371e9f</a> by Timothée Mazzucotelli).</li> <li>Stop accepting sets as return value of <code>get_anchors</code> (only tuples), to preserve order (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/2e10374be258e9713b26f73dd06d0c2520ec07a5">2e10374</a> by Timothée Mazzucotelli).</li> <li>Remove deprecated parts (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/0a90a474c8dcbd95821700d7dab63f03e392c40f">0a90a47</a> by Timothée Mazzucotelli).</li> <li>Use proper parameters in <code>Inventory.register</code> method (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/433c6e01aab9333589f755e483f124db0836f143">433c6e0</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/c071740f20ab7b5d5d1a4ef1fc7193663280a903"><code>c071740</code></a> chore: Prepare release 0.23.0</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/3ed3453b893b53ee129cbd9fece3402c7e7083fb"><code>3ed3453</code></a> refactor: Don't sort inventories when reading them, it's useless</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/9397460bc7a6de4c73e0a545b9bc148db29893cf"><code>9397460</code></a> refactor: Try calling deprecated <code>get_anchor</code> for a bit longer</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/fe8e3c5044c7dffa5c2de0c7532fe015cfd9383a"><code>fe8e3c5</code></a> docs: Enable auto-summaries</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/b89bb2de34b23908edff0aa82813404702d29600"><code>b89bb2d</code></a> docs: Remove old contents</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/9371e9fc7dd68506b73aa1580a12c5f5cd779aba"><code>9371e9f</code></a> refactor: Sort inventories</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/228fb737caca4e20e600053bf59cbfa3e9c73906"><code>228fb73</code></a> feat: Register all anchors for each object in the inventory</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/0b06d6a7ea1e45edfb066cfd3acb4bfca9927b47"><code>0b06d6a</code></a> docs: Fix link (MkDocs 1.5)</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/43960110c9c2edf741351727c0d1a31d2eabc7ec"><code>4396011</code></a> chore: Template upgrade</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/7690d41e2871997464367e673023585c4fb05e26"><code>7690d41</code></a> fix: Don't add <code>codehilite</code> CSS class to inline code</li> <li>Additional commits viewable in <a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.22.0...0.23.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.22.0&new-version=0.23.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 e38190a + 113ccc7 commit 8d41bb6

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
@@ -48,7 +48,7 @@ dev-mkdocs = [
4848
"mkdocs-literate-nav == 0.6.0",
4949
"mkdocs-material == 9.2.5",
5050
"mkdocs-section-index == 0.3.5",
51-
"mkdocstrings[python] == 0.22.0",
51+
"mkdocstrings[python] == 0.23.0",
5252
"frequenz-repo-config[lib] == 0.4.0",
5353
]
5454
dev-mypy = [

0 commit comments

Comments
 (0)