Skip to content

Releases: mkdocstrings/python

1.7.1

28 Sep 13:41
Compare
Choose a tag to compare

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

14 Sep 13:32
Compare
Choose a tag to compare

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

11 Sep 16:58
Compare
Choose a tag to compare

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

05 Sep 11:49
Compare
Choose a tag to compare

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

04 Sep 15:00
Compare
Choose a tag to compare

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

27 Aug 17:38
Compare
Choose a tag to compare

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

25 Aug 13:55
Compare
Choose a tag to compare

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

24 Aug 12:55
Compare
Choose a tag to compare

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

20 Aug 15:21
Compare
Choose a tag to compare

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

18 Aug 14:57
Compare
Choose a tag to compare

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).