Build: Bump mkdocstrings from 0.27.0 to 0.28.0 (#1604)

Bumps [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings) from
0.27.0 to 0.28.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.28.0</h2>
<h2><a
href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.28.0">0.28.0</a>
- 2025-02-03</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/mkdocstrings/compare/0.27.0...0.28.0">Compare
with 0.27.0</a><!-- raw HTML omitted --></p>
<h3>Breaking Changes</h3>
<p>Although the following changes are &quot;breaking&quot; in terms of
public API, we didn't find any public use of these classes and methods
on GitHub.</p>
<ul>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(parser)</code>:
<em>Parameter was removed</em></li>
<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(md)</code>:
<em>Positional parameter was moved</em></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(config)</code>:
<em>Parameter was removed</em></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(handlers)</code>:
<em>Parameter kind was changed</em>: <code>positional or keyword</code>
-&gt; <code>keyword-only</code></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(autorefs)</code>:
<em>Parameter kind was changed</em>: <code>positional or keyword</code>
-&gt; <code>keyword-only</code></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(config)</code>:
<em>Parameter was removed</em></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(handlers)</code>:
<em>Positional parameter was moved</em></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs)</code>:
<em>Positional parameter was moved</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(config)</code>:
<em>Parameter was removed</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(theme)</code>:
<em>Parameter was added as required</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(default)</code>:
<em>Parameter was added as required</em></li>

<li><code>mkdocstrings.handlers.base.Handlers.__init__(inventory_project)</code>:
<em>Parameter was added as required</em></li>

<li><code>mkdocstrings.handlers.base.Handlers.__init__(tool_config)</code>:
<em>Parameter was added as required</em></li>
</ul>
<p>Similarly, the following parameters were renamed, but the methods are
only called from our own code, using positional arguments.</p>
<ul>

<li><code>mkdocstrings.handlers.base.BaseHandler.collect(config)</code>:
<em>Parameter was renamed <code>options</code></em></li>
<li><code>mkdocstrings.handlers.base.BaseHandler.render(config)</code>:
<em>Parameter was renamed <code>options</code></em></li>
</ul>
<p>Finally, the following method was removed, but this is again taken
into account in our own code:</p>
<ul>
<li><code>mkdocstrings.handlers.base.BaseHandler.get_anchors</code>:
<em>Public object was removed</em></li>
</ul>
<p>For these reasons, and because we're still in v0, we do not bump to
v1 yet. See following deprecations.</p>
<h3>Deprecations</h3>
<p><em>mkdocstrings</em> 0.28 will start emitting these deprecations
warnings:</p>
<blockquote>
<p>The <code>handler</code> argument is deprecated. The handler name
must be specified as a class attribute.</p>
</blockquote>
<p>Previously, the <code>get_handler</code> function would pass a
<code>handler</code> (name) argument to the handler constructor. This
name must now be set on the handler's class directly.</p>
<pre lang="python"><code>class MyHandler:
name = &quot;myhandler&quot;
</code></pre>
<blockquote>
<p>The <code>domain</code> attribute must be specified as a class
attribute.</p>
</blockquote>
<p>The <code>domain</code> class attribute on handlers is now mandatory
and cannot be an empty string.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</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.28.0">0.28.0</a>
- 2025-02-03</h2>
<p><!-- raw HTML omitted --><a
href="https://github.com/mkdocstrings/mkdocstrings/compare/0.27.0...0.28.0">Compare
with 0.27.0</a><!-- raw HTML omitted --></p>
<h3>Breaking Changes</h3>
<p>Although the following changes are &quot;breaking&quot; in terms of
public API, we didn't find any public use of these classes and methods
on GitHub.</p>
<ul>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(parser)</code>:
<em>Parameter was removed</em></li>
<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(md)</code>:
<em>Positional parameter was moved</em></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(config)</code>:
<em>Parameter was removed</em></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(handlers)</code>:
<em>Parameter kind was changed</em>: <code>positional or keyword</code>
-&gt; <code>keyword-only</code></li>

<li><code>mkdocstrings.extension.AutoDocProcessor.__init__(autorefs)</code>:
<em>Parameter kind was changed</em>: <code>positional or keyword</code>
-&gt; <code>keyword-only</code></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(config)</code>:
<em>Parameter was removed</em></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(handlers)</code>:
<em>Positional parameter was moved</em></li>

<li><code>mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs)</code>:
<em>Positional parameter was moved</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(config)</code>:
<em>Parameter was removed</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(theme)</code>:
<em>Parameter was added as required</em></li>
<li><code>mkdocstrings.handlers.base.Handlers.__init__(default)</code>:
<em>Parameter was added as required</em></li>

<li><code>mkdocstrings.handlers.base.Handlers.__init__(inventory_project)</code>:
<em>Parameter was added as required</em></li>

<li><code>mkdocstrings.handlers.base.Handlers.__init__(tool_config)</code>:
<em>Parameter was added as required</em></li>
</ul>
<p>Similarly, the following parameters were renamed, but the methods are
only called from our own code, using positional arguments.</p>
<ul>

<li><code>mkdocstrings.handlers.base.BaseHandler.collect(config)</code>:
<em>Parameter was renamed <code>options</code></em></li>
<li><code>mkdocstrings.handlers.base.BaseHandler.render(config)</code>:
<em>Parameter was renamed <code>options</code></em></li>
</ul>
<p>Finally, the following method was removed, but this is again taken
into account in our own code:</p>
<ul>
<li><code>mkdocstrings.handlers.base.BaseHandler.get_anchors</code>:
<em>Public object was removed</em></li>
</ul>
<p>For these reasons, and because we're still in v0, we do not bump to
v1 yet. See following deprecations.</p>
<h3>Deprecations</h3>
<p><em>mkdocstrings</em> 0.28 will start emitting these deprecations
warnings:</p>
<blockquote>
<p>The <code>handler</code> argument is deprecated. The handler name
must be specified as a class attribute.</p>
</blockquote>
<p>Previously, the <code>get_handler</code> function would pass a
<code>handler</code> (name) argument to the handler constructor. This
name must now be set on the handler's class directly.</p>
<pre lang="python"><code>class MyHandler:
    name = &quot;myhandler&quot;
</code></pre>
<blockquote>
<p>The <code>domain</code> attribute must be specified as a class
attribute.</p>
</blockquote>
<p>The <code>domain</code> class attribute on handlers is now mandatory
and cannot be an empty string.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/6ef141222d0b5ad47ced9049472243cf5887ec0e"><code>6ef1412</code></a>
chore: Prepare release 0.28.0</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/936275e9b740ea122a484a686fcebc3424ec757a"><code>936275e</code></a>
Merge branch 'main' of github.com:mkdocstrings/mkdocstrings</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/3cf7d51704378adc50d4ea50080aacae39e0e731"><code>3cf7d51</code></a>
fix: Update handlers in JSON schema to be an object instead of an
array</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/f3ecf5868c33944b344a31a2423952d7f4eb1952"><code>f3ecf58</code></a>
chore: Ignore autorefs fallback deprecation warning</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/9618e17a66cd6bf3cdf4445dddde97c1680039a0"><code>9618e17</code></a>
docs: Mention mkdocs-api-autonav in recipe</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/52ea2f216b6481c625c2ee15333cb64ec386b370"><code>52ea2f2</code></a>
ci: Upgrade dev-deps to prevent warnings in tests</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/8c476ee0b82c09a5b20d7a773ecaf4be17b9e4d1"><code>8c476ee</code></a>
refactor: Pass <code>config_file_path</code> to <code>get_handler</code>
if it expects it</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/053ef23ca1d02a3ff47832947d71ce664a2756cd"><code>053ef23</code></a>
Merge branch 'main' of github.com:mkdocstrings/mkdocstrings</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/48625a2d37c90653ac275031dc8a3cf1c607408b"><code>48625a2</code></a>
chore: Fix inventory loading error log message</li>
<li><a
href="https://github.com/mkdocstrings/mkdocstrings/commit/060e437485fa5026d70c941a17df4049ebbb904e"><code>060e437</code></a>
docs: Fix link to arithmatex docs in Material for MkDocs</li>
<li>Additional commits viewable in <a
href="https://github.com/mkdocstrings/mkdocstrings/compare/0.27.0...0.28.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.27.0&new-version=0.28.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>

pyproject.toml

@@ -102,7 +102,7 @@ docutils = "!=0.21.post1"   # https://github.com/python-poetry/poetry/issues/924
 mkdocs = "1.6.1"
 griffe = "1.5.6"
 jinja2 = "3.1.5"
-mkdocstrings = "0.27.0"
+mkdocstrings = "0.28.0"
 mkdocstrings-python = "1.13.0"
 mkdocs-literate-nav = "0.6.1"
 mkdocs-autorefs = "1.3.0"