Changelog¤

mkdocstrings-python Insiders¤

1.9.0 September 03, 2024¤

• Relative cross-references
• Scoped cross-references

1.8.3 June 19, 2024¤

• Update code for Griffe 0.46+ to avoid deprecation warnings

1.8.2 May 09, 2024¤

• Don't render cross-refs for default values when signatures aren't separated

1.8.1 April 19, 2024¤

• Render enumeration instance name instead of just "value", allowing proper cross-reference

1.8.0 March 24, 2024¤

• Annotations modernization

1.7.0 March 24, 2024¤

• Class inheritance diagrams with Mermaid

1.6.0 January 30, 2024¤

• Render cross-references to parameters documentation in signatures and attribute values.
• Add parameter_headings option to render headings for parameters (enabling permalinks and ToC/inventory entries).
• Render cross-references for default parameter values in signatures.

1.5.1 September 12, 2023¤

• Prevent empty auto-summarized Methods section.

1.5.0 September 05, 2023¤

• Render function signature overloads.

1.4.0 August 27, 2023¤

• Render cross-references in attribute signatures.

1.3.0 August 24, 2023¤

• Add "method" symbol type.

1.2.0 August 20, 2023¤

• Add member auto-summaries.

1.1.4 July 17, 2023¤

• Fix heading level increment for class members.

1.1.3 July 17, 2023¤

• Fix heading level (avoid with clause preventing to decrease it).

1.1.2 July 15, 2023¤

• Use non-breaking spaces after symbol types.

1.1.1 June 27, 2023¤

• Correctly escape expressions in signatures and other rendered types.

1.1.0 June 4, 2023¤

• Add Symbol types in headings and table of contents.

1.0.0 May 10, 2023¤

• Add cross-references for type annotations in signatures. Make sure to update your local templates as the signature of the format_signature filter has changed. The templates that must be updated: class.html, expression.html, function.html and signature.html.