Mkdocstrings Versions Save

0.25.1 - 2024-05-05

Compare with 0.25.0

Bug Fixes

• Always descend into sub-headings when re-applying their label (cb86e08 by Timothée Mazzucotelli). Issue-mkdocstrings/python-158

0.25.0 - 2024-04-27

Compare with 0.24.3

Features

• Support once parameter in logging methods, allowing to log a message only once with a given logger (1532b59 by Timothée Mazzucotelli).
• Support blank line between ::: path and YAML options (d799d2f by Timothée Mazzucotelli). Issue-450

Code Refactoring

• Allow specifying name of template loggers (c5b5f69 by Timothée Mazzucotelli).

0.24.3 - 2024-04-05

Compare with 0.24.2

Bug Fixes

• Support HTML toc labels with Python-Markdown 3.6+ (uncomment code...) (7fe3e5f by Timothée Mazzucotelli).

0.24.2 - 2024-04-02

Compare with 0.24.1

Bug Fixes

• Support HTML toc labels with Python-Markdown 3.6+ (c0d0090 by Timothée Mazzucotelli). Issue-mkdocstrings/python-143

0.24.1 - 2024-02-27

Compare with 0.24.0

Code Refactoring

• Support new pymdownx-highlight options (a7a2907 by Timothée Mazzucotelli).
• Backup anchors with id and no href, for compatibility with autorefs' Markdown anchors (b5236b4 by Timothée Mazzucotelli). PR-#651, Related-to-mkdocs-autorefs#39, Co-authored-by: Oleh Prypin [email protected]

0.24.0 - 2023-11-14

Compare with 0.23.0

Features

• Cache downloaded inventories as local file (ce84dd5 by Oleh Prypin). PR #632

Bug Fixes

• Make custom_templates relative to the config file (370a61d by Waylan Limberg). Issue #477, PR #627
• Remove duplicated headings for docstrings nested in tabs/admonitions (e2123a9 by Perceval Wajsburt, f4a94f7 by Oleh Prypin). Issue #609, PR #610, PR #613

Code Refactoring

• Drop support for MkDocs < 1.4, modernize usages (b61d4d1 by Oleh Prypin). PR #629

0.23.0 - 2023-08-28

Compare with 0.22.0

Breaking Changes

• Removed BaseCollector and BaseRenderer classes: they were merged into the BaseHandler class.
• Removed the watch feature, as MkDocs now provides it natively.
• Removed support for selection and rendering keys in YAML blocks: use options instead.
• Removed support for loading handlers from the mkdocstrings.handler namespace. Handlers must now be packaged under the mkdocstrings_handlers namespace.

Features

• Register all anchors for each object in the inventory (228fb73 by Timothée Mazzucotelli).

Bug Fixes

• Don't add codehilite CSS class to inline code (7690d41 by Timothée Mazzucotelli).
• Support cross-references for API docs rendered in top-level index page (b194452 by Timothée Mazzucotelli).

Code Refactoring

• Sort inventories before writing them to disk (9371e9f by Timothée Mazzucotelli).
• Stop accepting sets as return value of get_anchors (only tuples), to preserve order (2e10374 by Timothée Mazzucotelli).
• Remove deprecated parts (0a90a47 by Timothée Mazzucotelli).
• Use proper parameters in Inventory.register method (433c6e0 by Timothée Mazzucotelli).

Features

• Add enabled configuration option (8cf117d by StefanBRas). Issue #478, PR #504

Bug Fixes

• Handle updating Jinja environment of multiple handlers (a6ea80c by David Patterson). Related PR #201, Issue #502, PR #507

Code Refactoring

• Make _load_inventory accept lists as arguments (105ed82 by Sorin Sbarnea). Needed by PR mkdocstrings/python#49, PR #511
• Remove support for MkDocs < 1.2 (we already depended on MkDocs >= 1.2) (ac963c8 by Timothée Mazzucotelli).

Highlights

We decided to deprecate a few things to pave the way towards a more stable code base, bringing us closer to a v1.

• Selection and rendering options are now combined into a single options key. Using the old keys will emit a deprecation warning.
• The BaseCollector and BaseRenderer classes are deprecated in favor of BaseHandler, which merges their functionality. Using the old classes will emit a deprecation warning.

New versions of the Python handler and the legacy Python handler were also released in coordination with mkdocstrings 0.19. See their respective changelogs: python, python-legacy. Most notably, the Python handler gained the members and filters options that prevented many users to switch to it.

mkdocstrings stopped depending directly on the legacy Python handler. It means you now have to explicitely depend on it, directly or through the extra provided by mkdocstrings, if you want to continue using it.

Packaging / Dependencies

• Stop depending directly on mkdocstrings-python-legacy (9055d58 by Timothée Mazzucotelli). Issue #376

Features

• Pass config file path to handlers (cccebc4 by Timothée Mazzucotelli). Issue #311, PR #425

Code Refactoring

• Support options / deprecated options mix-up (7c71f26 by Timothée Mazzucotelli).
• Deprecate watch feature in favor of MkDocs' built-in one (c20022e by Timothée Mazzucotelli).
• Log relative template paths if possible, instead of absolute (91f5f83 by Timothée Mazzucotelli).
• Deprecate selection and rendering YAML keys (3335310 by Timothée Mazzucotelli). PR #420
• Deprecate BaseCollector and BaseRenderer (eb822cb by Timothée Mazzucotelli). PR #413

Highlights

• Python 3.6 support is dropped.
• We provide a new, experimental Python handler based on Griffe. This new handler brings automatic cross-references for every annotation in your code, including references to third-party libraries' APIs if they provide objects inventories and you explicitely load them in mkdocs.yml. See migration notes in the documentation.
• The "legacy" Python handler now lives in its own repository at https://github.com/mkdocstrings/python-legacy.

Packaging / Dependencies

• Add Crystal extra, update Python extras versions (b8222b0 by Timothée Mazzucotelli). PR #374
• Update autorefs to actually required version (fc6c7f6 by Timothée Mazzucotelli).
• Drop Python 3.6 support (7205ac6 by Timothée Mazzucotelli).

Features

• Allow unwrapping the <p> tag in convert_markdown filter (5351fc8 by Oleh Prypin). PR #369
• Support handlers spanning multiple locations (f42dfc6 by Timothée Mazzucotelli). PR #355

Code Refactoring

• Prefix logs with the package name only (6c2b734 by Timothée Mazzucotelli). PR #375
• Extract the Python handler into its own repository (74371e4 by Timothée Mazzucotelli). PR #356
• Support Jinja2 3.1 (b377227 by Timothée Mazzucotelli). Issue #360, PR #361
• Find templates in new and deprecated namespaces (d5d5f18 by Timothée Mazzucotelli). PR #367
• Support loading handlers from the mkdocstrings_handlers namespace (5c22c6c by Timothée Mazzucotelli). PR #367