tag:github.com,2008:https://github.com/mkdocstrings/mkdocstrings/releasesRelease notes from mkdocstrings2026-02-07T14:31:29Ztag:github.com,2008:Repository/226936416/1.0.32026-02-07T14:31:43Z1.0.3<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.3">1.0.3</a> - 2026-02-07</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/1.0.2...1.0.3">Compare with 1.0.2</a></p>
<h3>Bug Fixes</h3>
<ul>
<li>Forward extension instances directly passed from Zensical (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/65b27ec8d1d671eddf021e48b0114cc3f8aca14a">65b27ec</a> by Timothée Mazzucotelli).</li>
<li>Propagate Zensical's <code>zrelpath</code> processor (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/dbf263dfdd2fdd769d66fa62bdd388e05988bc78">dbf263d</a> by Timothée Mazzucotelli).</li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/1.0.22026-01-24T15:57:27Z1.0.2<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.2">1.0.2</a> - 2026-01-24</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/1.0.1...1.0.2">Compare with 1.0.1</a></p>
<h3>Code Refactoring</h3>
<ul>
<li>Use global instances for handlers and autorefs (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/9f79141d7eb35aba0c89a43795df0ee22a25a61e">9f79141</a> by Timothée Mazzucotelli).</li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/1.0.12026-01-19T11:36:27Z1.0.1<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.1">1.0.1</a> - 2026-01-19</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/1.0.0...1.0.1">Compare with 1.0.0</a></p>
<h3>Code Refactoring</h3>
<ul>
<li>Support manual cross-references in Zensical too (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/d37d9079e5381350b2e3ffc5f698e28a5b572d36">d37d907</a> by Timothée Mazzucotelli).</li>
<li>Support cross-references in Zensical (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/f43f1ee2cd38a0dba64fc7d0db3c5ffb037bf7f7">f43f1ee</a> by Timothée Mazzucotelli). <a href="https://github.com/mkdocstrings/mkdocstrings/pull/812" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/812/hovercard">PR-812</a></li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/1.0.02025-11-27T15:39:43Z1.0.0<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/1.0.0">1.0.0</a> - 2025-11-27</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.30.1...1.0.0">Compare with 0.30.1</a></p>
<h3>Breaking Changes</h3>
<ul>
<li><code>BaseHandler.name</code>: <em>Attribute value was changed</em>: <code>''</code> -> unset</li>
<li><code>BaseHandler.domain</code>: <em>Attribute value was changed</em>: <code>''</code> -> 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>github-actions[bot]tag:github.com,2008:Repository/226936416/0.30.12025-09-19T10:49:32Z0.30.1<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.30.1">0.30.1</a> - 2025-09-19</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.30.0...0.30.1">Compare with 0.30.0</a></p>
<h3>Bug Fixes</h3>
<ul>
<li>Create default SSL context in main thread before downloading inventories (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/eec7fb4bab948ef6db594fc1d1688be0554c5780">eec7fb4</a> by Çağlar Kutlu). <a href="https://github.com/mkdocstrings/mkdocstrings/issue/796">Issue-796</a>, <a href="https://github.com/mkdocstrings/mkdocstrings/pull/797" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/797/hovercard">PR-797</a></li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/0.30.02025-07-22T23:49:19Z0.30.0<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.30.0">0.30.0</a> - 2025-07-23</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.29.1...0.30.0">Compare with 0.29.1</a></p>
<h3>Features</h3>
<ul>
<li>Add <code>data-skip-inventory</code> boolean attribute for elements to skip registration in local inventory (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/f856160b03b2c27e1d75fdf4f315c273cb9d9247">f856160</a> by Bartosz Sławecki). <a href="https://github.com/mkdocstrings/mkdocstrings/issues/671" data-hovercard-type="issue" data-hovercard-url="/mkdocstrings/mkdocstrings/issues/671/hovercard">Issue-671</a>, <a href="https://github.com/mkdocstrings/mkdocstrings/pull/774" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/774/hovercard">PR-774</a></li>
<li>Add I18N support (translations) (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/2b4ed541bc707e55d959092d950ebeecc4fbd136">2b4ed54</a> by Nyuan Zhang). <a href="https://github.com/mkdocstrings/mkdocstrings/pull/645" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/645/hovercard">PR-645</a>, Co-authored-by: Timothée Mazzucotelli <a href="mailto:[email protected]">[email protected]</a></li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/0.29.12025-03-31T08:33:08Z0.29.1<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.29.1">0.29.1</a> - 2025-03-31</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.29.0...0.29.1">Compare with 0.29.0</a></p>
<h3>Dependencies</h3>
<ul>
<li>Remove unused typing-extensions dependency (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/ba98661b50e2cde19d8696d6c8ceecdbb49ce83f">ba98661</a> by Timothée Mazzucotelli).</li>
</ul>
<h3>Bug Fixes</h3>
<ul>
<li>Ignore invalid inventory lines (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/81caff5ff76f1a6606da9d2980e81ae9d2e02246">81caff5</a> by Josh Mitchell). <a href="https://github.com/mkdocstrings/mkdocstrings/pull/748" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/748/hovercard">PR-748</a></li>
</ul>
<h3>Code Refactoring</h3>
<ul>
<li>Rename loggers to "mkdocstrings" (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/1a980402c39728ce265d8998b396c34bf76a113d">1a98040</a> by Timothée Mazzucotelli).</li>
</ul>github-actions[bot]tag:github.com,2008:Repository/226936416/0.29.02025-03-10T13:10:14Z0.29.0<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.29.0">0.29.0</a> - 2025-03-10</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.3...0.29.0">Compare with 0.28.3</a></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://github.com/mkdocstrings/mkdocstrings/issues/723" data-hovercard-type="issue" data-hovercard-url="/mkdocstrings/mkdocstrings/issues/723/hovercard">Issue-723</a>, <a href="https://github.com/mkdocstrings/python/issues/153" data-hovercard-type="issue" data-hovercard-url="/mkdocstrings/python/issues/153/hovercard">Issue-mkdocstrings-python-153</a>, <a href="https://github.com/mkdocstrings/mkdocstrings/pull/739" data-hovercard-type="pull_request" data-hovercard-url="/mkdocstrings/mkdocstrings/pull/739/hovercard">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>github-actions[bot]tag:github.com,2008:Repository/226936416/0.28.32025-03-08T21:43:26Z0.28.3<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.28.3">0.28.3</a> - 2025-03-08</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.2...0.28.3">Compare with 0.28.2</a></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>github-actions[bot]tag:github.com,2008:Repository/226936416/0.28.22025-02-24T16:12:48Z0.28.2<h2><a href="https://github.com/mkdocstrings/mkdocstrings/releases/tag/0.28.2">0.28.2</a> - 2025-02-24</h2>
<p><a href="https://github.com/mkdocstrings/mkdocstrings/compare/0.28.1...0.28.2">Compare with 0.28.1</a></p>
<h3>Build</h3>
<ul>
<li>Depend on mkdocs-autorefs >= 1.4 (<a href="https://github.com/mkdocstrings/mkdocstrings/commit/2c22bdc49f6bf5600aefd5ec711747686fda96a8">2c22bdc</a> by Timothée Mazzucotelli).</li>
</ul>github-actions[bot]