Skip to content

Commit b86d7d5

Browse files
Build: Bump mkdocstrings from 0.28.2 to 0.29.0 (#1781)
Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from 0.28.2 to 0.29.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/mkdocstrings/mkdocstrings/releases">mkdocstrings's releases</a>.</em></p> <blockquote> <h2>0.29.0</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.29.0">0.29.0</a> - 2025-03-10</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.3...0.29.0">Compare with 0.28.3</a><!-- raw HTML omitted --></p> <p><strong>This is the last version before v1!</strong></p> <h3>Build</h3> <ul> <li>Depend on MkDocs 1.6 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/11bc400ab7089a47755f24a790c08f2f904c570b">11bc400</a> by Timothée Mazzucotelli).</li> </ul> <h3>Features</h3> <ul> <li>Support rendering backlinks through handlers (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/d4c7b9c42f2de5df234c1ffefae0405a120e383c">d4c7b9c</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/mkdocstrings/issues/723">Issue-723</a>, <a href="https://redirect.github.com/mkdocstrings/python/issues/153">Issue-mkdocstrings-python-153</a>, <a href="https://redirect.github.com/mkdocstrings/mkdocstrings/pull/739">PR-739</a></li> </ul> <h3>Code Refactoring</h3> <ul> <li>Save and forward titles to autorefs (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/f49fb29582714795ca03febf1ee243aa2992917e">f49fb29</a> by Timothée Mazzucotelli).</li> <li>Use a combined event (each split with a different priority) for <code>on_env</code> (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/8d1dd754b4babd3c4f9e6c1d8856be57fe4ba9ea">8d1dd75</a> by Timothée Mazzucotelli).</li> </ul> <h2>0.28.3</h2> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.28.3">0.28.3</a> - 2025-03-08</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.2...0.28.3">Compare with 0.28.2</a><!-- raw HTML omitted --></p> <h3>Deprecations</h3> <p>All public objects must now be imported from the top-level <code>mkdocstrings</code> module. Importing from submodules is deprecated, and will raise errors starting with v1. This should be the last deprecation before v1.</p> <h3>Build</h3> <ul> <li>Make <code>python</code> extra depend on latest mkdocstrings-python (1.16.2) (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/ba9003e96c8e5e01900743d5c464cbd228d732f4">ba9003e</a> by Timothée Mazzucotelli).</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Finish exposing/hiding public/internal objects (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/0723fc25fdf5d45bc3b949f370712a706b85fbab">0723fc2</a> by Timothée Mazzucotelli).</li> <li>Re-expose public API in the top-level <code>mkdocstrings</code> module (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/e66e08096d45f6790492d9a0b767d512e42f67a9">e66e080</a> by Timothée Mazzucotelli).</li> <li>Move modules to internal folder (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/23fe23f11011d0470a6342ca85e060e5ac2b6bd6">23fe23f</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's changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.29.0">0.29.0</a> - 2025-03-10</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.3...0.29.0">Compare with 0.28.3</a><!-- raw HTML omitted --></p> <p><strong>This is the last version before v1!</strong></p> <h3>Build</h3> <ul> <li>Depend on MkDocs 1.6 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/11bc400ab7089a47755f24a790c08f2f904c570b">11bc400</a> by Timothée Mazzucotelli).</li> </ul> <h3>Features</h3> <ul> <li>Support rendering backlinks through handlers (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/d4c7b9c42f2de5df234c1ffefae0405a120e383c">d4c7b9c</a> by Timothée Mazzucotelli). <a href="https://redirect.github.com/mkdocstrings/mkdocstrings/issues/723">Issue-723</a>, <a href="https://redirect.github.com/mkdocstrings/python/issues/153">Issue-mkdocstrings-python-153</a>, <a href="https://redirect.github.com/mkdocstrings/mkdocstrings/pull/739">PR-739</a></li> </ul> <h3>Code Refactoring</h3> <ul> <li>Save and forward titles to autorefs (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/f49fb29582714795ca03febf1ee243aa2992917e">f49fb29</a> by Timothée Mazzucotelli).</li> <li>Use a combined event (each split with a different priority) for <code>on_env</code> (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/8d1dd754b4babd3c4f9e6c1d8856be57fe4ba9ea">8d1dd75</a> by Timothée Mazzucotelli).</li> </ul> <h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.28.3">0.28.3</a> - 2025-03-08</h2> <p><!-- raw HTML omitted --><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.2...0.28.3">Compare with 0.28.2</a><!-- raw HTML omitted --></p> <h3>Deprecations</h3> <p>All public objects must now be imported from the top-level <code>mkdocstrings</code> module. Importing from submodules is deprecated, and will raise errors starting with v1. This should be the last deprecation before v1.</p> <h3>Build</h3> <ul> <li>Make <code>python</code> extra depend on latest mkdocstrings-python (1.16.2) (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/ba9003e96c8e5e01900743d5c464cbd228d732f4">ba9003e</a> by Timothée Mazzucotelli).</li> </ul> <h3>Code Refactoring</h3> <ul> <li>Finish exposing/hiding public/internal objects (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/0723fc25fdf5d45bc3b949f370712a706b85fbab">0723fc2</a> by Timothée Mazzucotelli).</li> <li>Re-expose public API in the top-level <code>mkdocstrings</code> module (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/e66e08096d45f6790492d9a0b767d512e42f67a9">e66e080</a> by Timothée Mazzucotelli).</li> <li>Move modules to internal folder (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/23fe23f11011d0470a6342ca85e060e5ac2b6bd6">23fe23f</a> by Timothée Mazzucotelli).</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/32e415d2ead0d524745ae90af78e1195c827f9ad"><code>32e415d</code></a> chore: Prepare release 0.29.0</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/44462d0096869dd7075d712e952bf6c3c905deb3"><code>44462d0</code></a> Merge branch 'main' of github.com:mkdocstrings/mkdocstrings</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/3366f5be7012aada5d8582c85ed92d76ccb1aa70"><code>3366f5b</code></a> docs: Escape <code>\&lt;p&gt;</code> in docstrings</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/d4c7b9c42f2de5df234c1ffefae0405a120e383c"><code>d4c7b9c</code></a> feat: Support rendering backlinks through handlers</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/f49fb29582714795ca03febf1ee243aa2992917e"><code>f49fb29</code></a> refactor: Save and forward titles to autorefs</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/8d1dd754b4babd3c4f9e6c1d8856be57fe4ba9ea"><code>8d1dd75</code></a> refactor: Use a combined event (each split with a different priority) for `on...</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/11bc400ab7089a47755f24a790c08f2f904c570b"><code>11bc400</code></a> build: Depend on MkDocs 1.6</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/fd28fff07aa24e6e1381f67455980fc4364fb86b"><code>fd28fff</code></a> chore: Prepare release 0.28.3</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/0723fc25fdf5d45bc3b949f370712a706b85fbab"><code>0723fc2</code></a> refactor: Finish exposing/hiding public/internal objects</li> <li><a href="https://github.com/mkdocstrings/mkdocstrings/commit/72e8baeb816e5c540a6d38e030ac20566ebb0d73"><code>72e8bae</code></a> docs: Simplify API docs</li> <li>Additional commits viewable in <a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.2...0.29.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=mkdocstrings&package-manager=pip&previous-version=0.28.2&new-version=0.29.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> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent 7648803 commit b86d7d5

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

poetry.lock

+6-7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ docutils = "!=0.21.post1" # https://github.com/python-poetry/poetry/issues/924
105105
mkdocs = "1.6.1"
106106
griffe = "1.6.0"
107107
jinja2 = "3.1.6"
108-
mkdocstrings = "0.28.2"
108+
mkdocstrings = "0.29.0"
109109
mkdocstrings-python = "1.16.2"
110110
mkdocs-literate-nav = "0.6.1"
111111
mkdocs-autorefs = "1.4.0"

0 commit comments

Comments
 (0)