Skip to content

Latest commit

 

History

History
184 lines (105 loc) · 10.4 KB

File metadata and controls

184 lines (105 loc) · 10.4 KB

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.

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

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