CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.11.1 - 2024-09-03

Compare with 1.11.0

Code Refactoring

• Prepare relative_crossrefs and scoped_crossrefs insiders features (dd8b014 by Timothée Mazzucotelli).

1.11.0 - 2024-09-03

Compare with 1.10.9

Features

• Hook into autorefs to provide context around cross-ref errors (bb4be5b by Timothée Mazzucotelli).

1.10.9 - 2024-08-30

Compare with 1.10.8

Build

• Explicitly depend on mkdocs-autorefs to be able to specify lower bound (2299ab5 by Timothée Mazzucotelli).

Code Refactoring

• Use new autorefs syntax (68cb72f by Timothée Mazzucotelli).

1.10.8 - 2024-08-14

Compare with 1.10.7

Build

• Depend on Griffe 0.49 (a87dcad by Timothée Mazzucotelli).

1.10.7 - 2024-07-25

Compare with 1.10.6

Packaging

• Include tests and all relevant files for downstream packaging in source distribution

1.10.6 - 2024-07-25

Compare with 1.10.5

Bug Fixes

• Fix condition to display members (check all members, not just non-inherited ones) (3d838a9 by Timothée Mazzucotelli).

Code Refactoring

• Update code for Griffe 0.48 (removing deprecation warnings) (eff10cc by Timothée Mazzucotelli). Issue-173

1.10.5 - 2024-06-19

Compare with 1.10.4

Bug Fixes

• Mix both previous checks for displaying objects: not imported or public (587963b by Timothée Mazzucotelli). Issue-294

1.10.4 - 2024-06-18

Compare with 1.10.3

Code Refactoring

• Only filter out imported objects instead of non-public ones after applying filters (e2f4b35 by Timothée Mazzucotelli). Issue-mkdocstrings/griffe-294
• Update code for Griffe 0.46 to avoid deprecation warnings (321b407 by Timothée Mazzucotelli).
• Change load_external_modules default value to None to support new default mode in Griffe (ae5896c by Timothée Mazzucotelli).

1.10.3 - 2024-05-22

Compare with 1.10.2

Bug Fixes

• Don't crash when rendering the source of an object whose lineno is none (64df00b by Timothée Mazzucotelli). Issue-163

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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 2023-10-09

Compare with 1.7.2

Bug Fixes

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

1.7.2 - 2023-10-05

Compare with 1.7.1

Bug Fixes

• Prevent alias resolution error when source-ordering members (67df10c by Timothée Mazzucotelli). Issue griffe#213

Code Refactoring

• Use package relative filepath if filepath is not relative (aa5a3f7 by Timothée Mazzucotelli). Discussion mkdocstrings#622

1.7.1 - 2023-09-28

Compare with 1.7.0

Bug Fixes

• Stop propagation of annotation to next parameter in signature template (3a760ac by Timothée Mazzucotelli). Issue #110

Code Refactoring

• Look into inherited members for __init__ methods when merging docstrings (b97d51f by Timothée Mazzucotelli). Issue #106

1.7.0 - 2023-09-14

Compare with 1.6.3

Features

• Add option to unwrap Annotated types (53db04b by Timothée Mazzucotelli).

1.6.3 - 2023-09-11

Compare with 1.6.2

Bug Fixes

• Make load_external_modules a global-only option (266f41f by Timothée Mazzucotelli). Issue #87
• Never fail when trying to format code with Black (df24bbc by Timothée Mazzucotelli).

Code Refactoring

• Wrap docstring section elements (list style) in code tags to prevent spell checker errors (1ae8dd8 by Timothée Mazzucotelli).

1.6.2 - 2023-09-05

Compare with 1.6.1

Bug Fixes

• Don't render cross-ref spans when they're not enabled (eed51ee by Timothée Mazzucotelli).

1.6.1 - 2023-09-04

Compare with 1.6.0

Bug Fixes

• Fix spacing for rendered named items in Yields, Receives and Returns sections (list style) (e12688e by Timothée Mazzucotelli).
• Fix rendering Receives sections as lists (9ff7e68 by Timothée Mazzucotelli).

1.6.0 - 2023-08-27

Compare with 1.5.2

Features

• Add doc-signature CSS class to separate signature code blocks (b6c648f by Timothée Mazzucotelli).

Code Refactoring

• Add a format_attribute filter, preparing for cross-refs in attribute signatures (8f0ade2 by Timothée Mazzucotelli).

1.5.2 - 2023-08-25

Compare with 1.5.1

Bug Fixes

• Regression in children template: fix condition for when members are specified (beeebff by Timothée Mazzucotelli). Issue #100
• Prevent whitespace removal before highlight filter (c6f36c0 by Timothée Mazzucotelli).

Code Refactoring

• Never show full object path in ToC entry (9aa758b by Timothée Mazzucotelli).
• Sync templates with insiders, remove useless lines (38b317f by Timothée Mazzucotelli).

1.5.1 - 2023-08-24

Compare with 1.5.0

Code Refactoring

• Never show full path in separate signature since it would appear in the heading already (9e02049 by Timothée Mazzucotelli).
• Improve guessing whether an object is public (35eb811 by Timothée Mazzucotelli).
• Always sort modules alphabetically as source order wouldn't make sense (70c81ce by Timothée Mazzucotelli).
• Return anchors as a tuple, not a set, to preserve order (736a2b5 by Timothée Mazzucotelli). Related-to #mkdocstrings/crystal#6

1.5.0 - 2023-08-20

Compare with 1.4.0

Features

• Add support for new Griffe docstring sections: modules, classes, and functions (methods) (d5337af by Timothée Mazzucotelli).

1.4.0 - 2023-08-18

Compare with 1.3.0

Features

• Support new Griffe expressions (in v0.33) (9b8e1b1 by Timothée Mazzucotelli).

Code Refactoring

• Deprecate crossref and multi_crossref filters (4fe3d20 by Timothée Mazzucotelli).

1.3.0 - 2023-08-06

Compare with 1.2.1

Dependencies

• Set upper bound on Griffe (0.33) (ad8c2a3 by Timothée Mazzucotelli). See mkdocstrings/griffe#195.

Features

• Show parameter default values within the "list" section style too (55f08f3 by Antoine Dechaume). PR #92, Co-authored-by: Timothée Mazzucotelli pawamoy@pm.me

1.2.1 - 2023-07-20

Compare with 1.2.0

Bug Fixes

• Fix members ordering when members are specified with a boolean (c69f9c3 by Timothée Mazzucotelli). Issue #89

1.2.0 - 2023-07-14

Compare with 1.1.2

Features

• Add Jinja blocks to module, class, function and attribute templates (299fe48 by Timothée Mazzucotelli).
• Setup infrastructure for I18N, add translations for simplified chinese and japanese (b053b29 by Nyuan Zhang). PR #77
• Support inheritance (ae42356 by Timothée Mazzucotelli). Issue mkdocstrings#157, Discussion mkdocstrings#536

Bug Fixes

• Don't show None as return annotation of class signatures (3d8724e by Timothée Mazzucotelli). Issue #85
• Show labels in deterministic order (02619a8 by Oleh Prypin).

1.1.2 - 2023-06-04

Compare with 1.1.1

Code Refactoring

• Keep headings style consistent (CSS) (92032e5 by Timothée Mazzucotelli).

1.1.1 - 2023-06-04

Compare with 1.1.0

Bug Fixes

• Fix mkdocs and readthedocs themes support (14f18b2 by Timothée Mazzucotelli).

Code Refactoring

• Improve display of paragraphs in docstring sections (439f5e6 by Timothée Mazzucotelli).

1.1.0 - 2023-05-25

Compare with 1.0.0

Features

• Support custom templates through objects' extra data (8ff2b06 by Timothée Mazzucotelli). PR #70

1.0.0 - 2023-05-11

Compare with 0.10.1

Breaking changes

• The signature of the format_signature filter has changed. If you override templates in your project to customize the output, make sure to update the following templates so that they use the new filter signature:

  • class.html
  • expression.html
  • function.html
  • signature.html

  You can see how to use the filter in this commit's changes: f686f4e4.

We take this as an opportunity to go out of beta and bump the version to 1.0.0. This will allow users to rely on semantic versioning.

Bug Fixes

• Bring compatibility with insiders signature crossrefs feature (f686f4e by Timothée Mazzucotelli).

0.10.1 - 2023-05-07

Compare with 0.10.0

Bug Fixes

• Format signatures with full-path names (685512d by Timothée Mazzucotelli).

0.10.0 - 2023-05-07

Compare with 0.9.0

Features

• Add option to disallow inspection (40f2f26 by Nyuan Zhang). Issue #68, PR #69

Bug Fixes

• Make admonitions open by default (79cd153 by Timothée Mazzucotelli). Issue #22

Code Refactoring

• Match documented behavior for filtering (all members, list, none) (c7f70c3 by Timothée Mazzucotelli).
• Switch to an info level log for when black's not installed (f593bb0 by Faster Speeding).
• Return anchors as a set (e2b820c by Timothée Mazzucotelli).

0.9.0 - 2023-04-03

Compare with 0.8.3

Features

• Allow resolving alias to external modules (02052e2 by Gilad). PR #61, Follow-up of PR #60
• Allow pre-loading modules (36002cb by Gilad). Issue mkdocstrings/mkdocstrings#503, PR #60
• Add show options for docstrings (a6c55fb by Jeremy Goh). Issue mkdocstrings/mkdocstrings#466, PR #56
• Allow custom list of domains for inventories (f5ea6fd by Sorin Sbarnea). Issue mkdocstrings/mkdocstrings#510, PR #49

Bug Fixes

• Prevent alias resolution error when searching for anchors (a190e2c by Timothée Mazzucotelli). Issue #64

Code Refactoring

• Support Griffe 0.26 (075735c by Timothée Mazzucotelli).
• Log (debug) unresolved aliases (9164742 by Timothée Mazzucotelli).

0.8.3 - 2023-01-04

Compare with 0.8.2

Code Refactoring

• Change "unresolved aliases" log level to DEBUG (dccb818 by Timothée Mazzucotelli).

0.8.2 - 2022-11-19

Compare with 0.8.1

Bug Fixes

• Fix base directory used to expand globs (34cfa4b by Florian Hofer). PR #45

0.8.1 - 2022-11-19

Compare with 0.8.0

Bug Fixes

• Expand globs relative to configuration file path (0dc45ae by David Vegh). Issue #42, PR #43

0.8.0 - 2022-11-13

Compare with 0.7.1

Features

• Add support for globs in paths configuration (29edd02 by Andrew Guenther). Issue #33, PR #34

Code Refactoring

• Support Griffe 0.24 (3b9f701 by Timothée Mazzucotelli).

0.7.1 - 2022-06-12

Compare with 0.7.0

Bug Fixes

• Fix rendering of / in signatures (3e927e4 by Timothée Mazzucotelli). Issue #25

0.7.0 - 2022-05-28

Compare with 0.6.6

Packaging / Dependencies

• Depend on mkdocstrings 0.19 (b6a9a47 by Timothée Mazzucotelli).

Features

• Add config option for annotations paths verbosity (b6c9893 by Timothée Mazzucotelli).
• Use sections titles in SpaCy-styled docstrings (fe16b54 by Timothée Mazzucotelli).
• Wrap objects names in spans to allow custom styling (0822ff9 by Timothée Mazzucotelli). Issue mkdocstrings/mkdocstrings#240
• Add Jinja blocks around docstring section styles (aaa79ee by Timothée Mazzucotelli).
• Add members and filters options (24a6136 by Timothée Mazzucotelli).
• Add paths option (dd41182 by Timothée Mazzucotelli). Issue mkdocstrings/mkdocstrings#311, PR #20

Bug Fixes

• Fix CSS class on labels (312a709 by Timothée Mazzucotelli).
• Fix categories rendering (6407cf4 by Timothée Mazzucotelli). Issue #14

Code Refactoring

• Disable show_submodules by default (480d0c3 by Timothée Mazzucotelli).
• Merge default configuration options in handler (347ce76 by Timothée Mazzucotelli).
• Reduce number of template debug logs (8fed314 by Timothée Mazzucotelli).
• Respect show_root_full_path for ToC entries (hidden headings) (8f4c853 by Timothée Mazzucotelli).
• Bring consistency on headings style (59104c4 by Timothée Mazzucotelli).
• Stop using deprecated base classes (d5ea1c5 by Timothée Mazzucotelli).

0.6.6 - 2022-03-06

Compare with 0.6.5

Code Refactoring

• Always hide self and cls parameters (7f579d1 by Timothée Mazzucotelli). Issue #7
• Use pycon for examples code blocks (6545900 by Timothée Mazzucotelli).

0.6.5 - 2022-02-24

Compare with 0.6.4

Bug Fixes

• Don't escape signatures return annotations (ac54bfc by Timothée Mazzucotelli). Issue #6

0.6.4 - 2022-02-22

Compare with 0.6.3

Bug Fixes

• Fix rendering of signature return annotation (b92ba3b by Timothée Mazzucotelli). Issue #4

0.6.3 - 2022-02-20

Compare with 0.6.2

Bug Fixes

• Fix examples rendering (a06a7e3 by Timothée Mazzucotelli). Issue mkdocstrings/griffe#46

0.6.2 - 2022-02-17

Compare with 0.6.1

Bug Fixes

• Catch alias resolution errors (b734dd0 by Timothée Mazzucotelli).

0.6.1 - 2022-02-17

Compare with 0.6.0

Bug Fixes

• Don't pop from fallback config (bde32af by Timothée Mazzucotelli).
• Fix rendering init method source when merged into class (4a20aea by Timothée Mazzucotelli).

0.6.0 - 2022-02-13

Compare with 0.5.4

Features

• Add option to merge __init__ methods' docstrings into their classes' docstrings (1b4d1c0 by Timothée Mazzucotelli).
• Support separate attribute signature (e962b88 by Timothée Mazzucotelli).

Bug Fixes

• Restore full cross-refs paths on hover (ac11970 by Timothée Mazzucotelli).
• Fix rendering of labels (52919c5 by Timothée Mazzucotelli).

Code Refactoring

• Don't add trailing parentheses in functions heading when separate signature (885696e by Timothée Mazzucotelli).
• Use more explicit template debug messages (f2122d7 by Timothée Mazzucotelli).

0.5.4 - 2022-02-13

Compare with 0.5.3

Bug Fixes

• Don't load additional modules during fallback (69b8e25 by Timothée Mazzucotelli).

0.5.3 - 2022-02-08

Compare with 0.5.2

Bug Fixes

• Allow passing null as docstring style (f526816 by Timothée Mazzucotelli). Issue #2

0.5.2 - 2022-02-05

Compare with 0.5.1

Dependencies

• Require at least mkdocstrings 0.18 (7abdda4 by Timothée Mazzucotelli).

0.5.1 - 2022-02-03

Compare with 0.5.0

Dependencies

• Depend on Griffe >= 0.11.1 (1303557 by Timothée Mazzucotelli).

Code Refactoring

• Move handler into its own module (b787e78 by Timothée Mazzucotelli).

0.5.0 - 2022-02-03

Compare with 0.4.1

Features

• Allow changing docstring style of an object (39240c1 by Timothée Mazzucotelli).

Bug Fixes

• Warn if Black is not installed when formatting signature (b848277 by Timothée Mazzucotelli).
• Fix missing default for docstring_section_style option (774988e by Timothée Mazzucotelli).

Code Refactoring

• Change to new way of stripping paragraphs (33d4594 by Timothée Mazzucotelli).

0.4.1 - 2022-02-01

Compare with 0.4.0

Bug Fixes

• Fix docstring admonitions rendering (a24ae2e by Timothée Mazzucotelli).

0.4.0 - 2022-02-01

Compare with 0.3.0

Code Refactoring

• Use the new mkdocstrings_handlers namespace (23c9023 by Timothée Mazzucotelli).

0.3.0 - 2022-01-14

Compare with 0.2.0

Features

• Support griffe 0.10 (28061de by Timothée Mazzucotelli).

Dependencies

• Require griffe 0.10 (cfbd7bb by Timothée Mazzucotelli).

Code Refactoring

• Use new logger patching utility (4cdb292 by Timothée Mazzucotelli).

0.2.0 - 2021-12-28

Compare with 0.1.0

Dependencies

• Depend on griffe >= 0.7.1 (34f7ebd by Timothée Mazzucotelli).
• Upgrade griffe, no upper bound (8f0aa42 by Timothée Mazzucotelli).

Features

• Add show_signature rendering option (0f07c2e by Will Da Silva).

Bug Fixes

• Fix templates for named docstring elements (47868a1 by Timothée Mazzucotelli).

0.1.0 - 2021-12-19

Compare with first commit

Features

• Implement handler and add templates (dbb580a by Timothée Mazzucotelli).

Bug Fixes

• Fix separate signature feature (da6e81c by Timothée Mazzucotelli).
• Fix signature template (parameters annotations) (b34ead0 by Timothée Mazzucotelli).
• Only show source when present (c270d68 by Timothée Mazzucotelli).

Code Refactoring

• Return all known anchors (9bbfe14 by Timothée Mazzucotelli).
• Update for griffe 0.4.0 (831aabb by Timothée Mazzucotelli).