Skip to content

Releases: mkdocstrings/mkdocstrings

1.0.3

07 Feb 14:31
1.0.3
8bdff16

Choose a tag to compare

1.0.3 - 2026-02-07

Compare with 1.0.2

Bug Fixes

  • Forward extension instances directly passed from Zensical (65b27ec by Timothée Mazzucotelli).
  • Propagate Zensical's zrelpath processor (dbf263d by Timothée Mazzucotelli).

1.0.2

24 Jan 15:57
1.0.2
4e66617

Choose a tag to compare

1.0.2 - 2026-01-24

Compare with 1.0.1

Code Refactoring

  • Use global instances for handlers and autorefs (9f79141 by Timothée Mazzucotelli).

1.0.1

19 Jan 11:36
1.0.1
cb8a3c7

Choose a tag to compare

1.0.1 - 2026-01-19

Compare with 1.0.0

Code Refactoring

  • Support manual cross-references in Zensical too (d37d907 by Timothée Mazzucotelli).
  • Support cross-references in Zensical (f43f1ee by Timothée Mazzucotelli). PR-812

1.0.0

27 Nov 15:39
1.0.0
68760a9

Choose a tag to compare

1.0.0 - 2025-11-27

Compare with 0.30.1

Breaking Changes

  • BaseHandler.name: Attribute value was changed: '' -> unset
  • BaseHandler.domain: Attribute value was changed: '' -> unset
  • BaseHandler.fallback_config: Public object was removed
  • BaseHandler.__init__(args): Parameter was removed
  • BaseHandler.__init__(kwargs): Parameter was removed
  • BaseHandler.__init__(theme): Parameter was added as required
  • BaseHandler.__init__(custom_templates): Parameter was added as required
  • BaseHandler.__init__(mdx): Parameter was added as required
  • BaseHandler.__init__(mdx_config): Parameter was added as required
  • BaseHandler.update_env(args): Parameter was removed
  • BaseHandler.update_env(kwargs): Parameter was removed
  • BaseHandler.update_env(config): Parameter was added as required
  • Handlers.get_anchors: Public object was removed (import from mkdocstrings directly)
  • mkdocstrings.plugin: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.loggers: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.inventory: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.extension: Public module was removed (import from mkdocstrings directly)
  • mkdocstrings.handlers: Public module was removed (import from mkdocstrings directly)

Code Refactoring

  • Remove deprecated code before v1 (de34044 by Timothée Mazzucotelli).
  • Expect Zensical to pass extension configuration instead of loading it again from YAML (6b73d5a by Timothée Mazzucotelli).
  • Expose the Markdown extension, to make mkdocstrings compatible with Zensical (6de2667 by Timothée Mazzucotelli).

0.30.1

19 Sep 10:49

Choose a tag to compare

0.30.1 - 2025-09-19

Compare with 0.30.0

Bug Fixes

  • Create default SSL context in main thread before downloading inventories (eec7fb4 by Çağlar Kutlu). Issue-796, PR-797

0.30.0

22 Jul 23:49

Choose a tag to compare

0.30.0 - 2025-07-23

Compare with 0.29.1

Features

  • Add data-skip-inventory boolean attribute for elements to skip registration in local inventory (f856160 by Bartosz Sławecki). Issue-671, PR-774
  • Add I18N support (translations) (2b4ed54 by Nyuan Zhang). PR-645, Co-authored-by: Timothée Mazzucotelli [email protected]

0.29.1

31 Mar 08:33

Choose a tag to compare

0.29.1 - 2025-03-31

Compare with 0.29.0

Dependencies

  • Remove unused typing-extensions dependency (ba98661 by Timothée Mazzucotelli).

Bug Fixes

  • Ignore invalid inventory lines (81caff5 by Josh Mitchell). PR-748

Code Refactoring

  • Rename loggers to "mkdocstrings" (1a98040 by Timothée Mazzucotelli).

0.29.0

10 Mar 13:10

Choose a tag to compare

0.29.0 - 2025-03-10

Compare with 0.28.3

This is the last version before v1!

Build

  • Depend on MkDocs 1.6 (11bc400 by Timothée Mazzucotelli).

Features

Code Refactoring

  • Save and forward titles to autorefs (f49fb29 by Timothée Mazzucotelli).
  • Use a combined event (each split with a different priority) for on_env (8d1dd75 by Timothée Mazzucotelli).

0.28.3

08 Mar 21:43

Choose a tag to compare

0.28.3 - 2025-03-08

Compare with 0.28.2

Deprecations

All public objects must now be imported from the top-level mkdocstrings module. Importing from submodules is deprecated, and will raise errors starting with v1. This should be the last deprecation before v1.

Build

  • Make python extra depend on latest mkdocstrings-python (1.16.2) (ba9003e by Timothée Mazzucotelli).

Code Refactoring

  • Finish exposing/hiding public/internal objects (0723fc2 by Timothée Mazzucotelli).
  • Re-expose public API in the top-level mkdocstrings module (e66e080 by Timothée Mazzucotelli).
  • Move modules to internal folder (23fe23f by Timothée Mazzucotelli).

0.28.2

24 Feb 16:12

Choose a tag to compare

0.28.2 - 2025-02-24

Compare with 0.28.1

Build

  • Depend on mkdocs-autorefs >= 1.4 (2c22bdc by Timothée Mazzucotelli).