1.10.2

1.10.2 - 2024-05-16

Compare with 1.10.1

Bug Fixes

• Actually make use of custom .html.jinja templates (5668abb by Timothée Mazzucotelli).

1.10.1

1.10.1 - 2024-05-14

Compare with 1.10.0

Build

• Depend on mkdocstrings 0.25 which adds support for parameter once when logging messages (2bc156b by Timothée Mazzucotelli).

Code Refactoring

• Set handler's name (a71ab12 by Timothée Mazzucotelli).
• Update *.html top-level templates to extend the *.html.jinja base templates (a8c540e by Timothée Mazzucotelli). Issue-151
• Update *.html base templates to extend their *.html.jinja counterpart, while overriding the logs block to issue a logging message (info) stating that extending *.html templates is deprecated (e6f1b9c by Timothée Mazzucotelli). Issue-151
• Add *.html.jinja top-level (overridable) templates, extending their base counterpart (7c14924 by Timothée Mazzucotelli). Issue-151
• Add *.html.jinja base templates, which are copies of *.html templates, with an additional logs block, and using the updated get_template filter (eced9a5 by Timothée Mazzucotelli). Issue-151
• Update get_template filter to support both *.html and *.html.jinja templates, logging a message (info) when *.html templates are overridden by users (3546fd7 by Timothée Mazzucotelli). Issue-151
• Log a warning when base templates are overridden (26e3d66 by Timothée Mazzucotelli). Issue-151

1.10.0

1.10.0 - 2024-04-19

Compare with 1.9.2

Features

• Add CSS classes doc-section-title and doc-section-item in docstring sections (d6e1d68 by Timothée Mazzucotelli). Issue-17

Bug Fixes

• Render enumeration instance name instead of just "value", allowing proper cross-reference (11d81d8 by Timothée Mazzucotelli). Issue-124

1.9.2

1.9.2 - 2024-04-02

Compare with 1.9.1

Dependencies

• Remove cap on Python-Markdown 3.6 now that ToC labels are fixed by mkdocstrings (0c1e2c1 by Timothée Mazzucotelli).

1.9.1

1.9.1 - 2024-04-02

Compare with 1.9.0

Bug Fixes

• Don't try loading packages from relative paths (bd73497 by Timothée Mazzucotelli). Issue-145

Code Refactoring

• Allow first name in a separate signature to be highlighted as a function name (f798a1e by Timothée Mazzucotelli).
• Maintain original Pygments color for cross-refs in signatures (7c8b885 by Timothée Mazzucotelli).

1.9.0

1.9.0 - 2024-03-13

Compare with 1.8.0

Dependencies

• Add upper bound on Python-Markdown 3.6 to temporarily prevent breaking changes (cd93ee3 by Timothée Mazzucotelli).

Features

• Add show_labels option to show/hide labels (eaf9b82 by Viicos). Issue #120, PR #130
• Add option to search for stubs packages (0c6aa32 by Romain). PR #128, PR griffe#221: : mkdocstrings/griffe#221

Code Refactoring

• Mark all Jinja blocks as scoped (548bdad by Timothée Mazzucotelli).

1.8.0

1.8.0 - 2024-01-08

Compare with 1.7.5

Features

• Release Insiders features of the $500/month funding goal (bd30106 by Timothée Mazzucotelli).
  The features and projects related to mkdocstrings-python are:

• Cross-references for type annotations in signatures

• Symbol types in headings and table of contents

• griffe-inherited-docstrings, a Griffe extension for inheriting docstrings

• griffe2md, a tool to output API docs to Markdown using Griffe

See the complete list of features and projects here:
https://pawamoy.github.io/insiders/#500-plasmavac-user-guide.

1.7.5

1.7.5 - 2023-11-21

Compare with 1.7.4

Bug Fixes

• Add missing translations (fallback theme) for ReadTheDocs (2fb6513 by Timothée Mazzucotelli). Issue #115

1.7.4

1.7.4 - 2023-11-12

Compare with 1.7.3

Bug Fixes

• Make extension paths relative to config file (5035e92 by Waylan Limberg). PR #112, Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me

Code Refactoring

• Prepare for Griffe 0.37 (b5bb8a9 by Timothée Mazzucotelli).

1.7.3

1.7.3 - 2023-10-09

Compare with 1.7.2

Bug Fixes

• Don't deepcopy the local config (1300d2c by Timothée Mazzucotelli).