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.1.0 - 2025-03-24¤

Compare with 0.0.1

The project gets released to everyone!

Build¤

• Depend on griffe-typedoc 0.1 (7d09f9a by Timothée Mazzucotelli).
• Require Python 3.10 minimum (1e5c521 by Timothée Mazzucotelli).
• Depend on mkdocstrings 0.28.3 (c5bf04e by Timothée Mazzucotelli).

Features¤

• Declare and use symbols for all kinds of objects (a2392aa by Timothée Mazzucotelli).
• Support specifying an object path (9b32feb by Timothée Mazzucotelli). Issue-22
• Pass symbol map to markdown method of objects, to allow generating autorefs (3324c2a by Timothée Mazzucotelli). Issue-5
• Suffix templates with jinja extension, add templates for enum, enum member, class and constructor (49fcd56 by Timothée Mazzucotelli). Issue-3, Issue-4
• Generate project with gh:mkdocstrings/handler-template Copier template (79a9244 by Timothée Mazzucotelli).

Bug Fixes¤

• Add templates for projects (9648248 by Timothée Mazzucotelli).
• Add templates for namespaces (277af0f by Timothée Mazzucotelli). Issue-mkdocstrings/typescript#16
• Add templates for accessors (57405cb by Timothée Mazzucotelli). Issue-13
• Collect project anyway, not just its children (3895e88 by Timothée Mazzucotelli). Issue-2

Code Refactoring¤

• Import from top-level mkdocstrings module (a16da56 by Timothée Mazzucotelli).
• Improve support for signatures rendering (wip) (bcbc314 by Timothée Mazzucotelli).

0.0.1 - 2024-05-08¤

Compare with first commit

Build¤

• Release no-op version (04dfa30 by Timothée Mazzucotelli).