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.

Compare with 0.8.0

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

Compare with 0.7.1

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

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

Compare with 0.7.0

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

Compare with 0.6.6

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

• 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

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

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

Compare with 0.6.5

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

Compare with 0.6.4

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

Compare with 0.6.3

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

Compare with 0.6.2

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

Compare with 0.6.1

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

Compare with 0.6.0

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

Compare with 0.5.4

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

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

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

Compare with 0.5.3

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

Compare with 0.5.2

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

Compare with 0.5.1

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

Compare with 0.5.0

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

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

Compare with 0.4.1

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

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

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

Compare with 0.4.0

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

Compare with 0.3.0

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

Compare with 0.2.0

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

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

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

Compare with 0.1.0

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

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

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

Compare with first commit

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

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

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