Skip to content

Releases: mkdocstrings/handler-template

1.3.0

11 Mar 13:24
Compare
Choose a tag to compare

1.3.0 - 2025-03-11

Compare with 1.2.4

Merge upstream

Features

  • Enable backlinks in API docs (20aba08 by Timothée Mazzucotelli).
  • Check legacy code with Yore each time the changelog is updated (63e4af5 by Timothée Mazzucotelli). Issue-60
  • Split dependency-groups in sections (bae928e by Dennis Bücker). Discussion-58, PR-59
  • Generate /llms.txt docs file (2000ef6 by Timothée Mazzucotelli). Issue-49
  • Add initial API tests (997155b by Timothée Mazzucotelli).
  • Add config to run project, and allow to pass arguments (bd88519 by Timothée Mazzucotelli). Issue-53

Bug Fixes

  • Output llms-full.txt, not llms.txt (2c8b4f8 by Timothée Mazzucotelli).
  • Ensure test jobs wait for quality one (for objects inventory artifact to be ready) (885f204 by Timothée Mazzucotelli).
  • Fix license choices in template configuration (f26c221 by Timothée Mazzucotelli).
  • Prevent extension crash with key error (1d27caf by Timothée Mazzucotelli).

Code Refactoring

  • Fully enable autorefs for docs (152924d by Timothée Mazzucotelli).
  • Simplify API docs (stop using gen-files and literate-nav) (6d1aec8 by Timothée Mazzucotelli).
  • Stop depending on Black now that mkdocstrings-python supports Ruff for formatting signatures (6554451 by Timothée Mazzucotelli).
  • Store and download objects inventory in CI, enabling API tests (a55906c by Timothée Mazzucotelli).
  • Prevent publishing insiders packages to PyPI (b51ae0f by Timothée Mazzucotelli). Issue-44
  • Mention insiders instead of pypi-insiders in docs (4c8d09e by Timothée Mazzucotelli). Issue-45
  • Write comments, not docstrings in internal modules/scripts (bedf879 by Timothée Mazzucotelli).
  • Use an "internal" layout (fd500cc by Timothée Mazzucotelli). Issue-50
  • Remove Ko-Fi and Paypal from funding file (16f0e0e by Timothée Mazzucotelli). Issue-55
  • Update setup-uv action version (52df1c1 by Timothée Mazzucotelli). Issue-54
  • Enable docs instant preview (link hover) (59b1229 by Timothée Mazzucotelli). Issue-52
  • Rename mkdocstrings-python import option to inventories (c56d1cc by Timothée Mazzucotelli).
  • Enable docs navigation breadcrumbs (15536d7 by Timothée Mazzucotelli).
  • Rename script that generates API reference (db1a856 by Timothée Mazzucotelli).
  • Set metadata title in docs pages (1837a07 by Timothée Mazzucotelli).
  • Update license templating (84537c7 by Timothée Mazzucotelli).
  • Update insiders docs now that we better handle beneficiaries (59bbbb5 by Timothée Mazzucotelli).

1.2.4

24 Jan 14:51
Compare
Choose a tag to compare

1.2.4 - 2025-01-23

Compare with 1.5.6

Merge upstream

Bug Fixes

  • Preserve symlinks (make -> make.py) (dab1219 by Timothée Mazzucotelli).

Code Refactoring

  • Enable Mypy colored output (c6622f8 by Timothée Mazzucotelli).

1.2.3

24 Dec 14:27
Compare
Choose a tag to compare

1.2.3 - 2024-12-24

Compare with 1.2.2

Merge upstream

Code Refactoring

  • Fallback onto finding current project version in CHANGELOG.md when Git tags give 0.1 or less (da5df83 by Timothée Mazzucotelli).

1.2.2

23 Dec 14:20
Compare
Choose a tag to compare

1.2.2 - 2024-12-23

Compare with 1.2.1

Merge upstream

Bug Fixes

  • Ignore constraints on main package (from dependencies), to allow resolving deps in forks/CI (d644679 by Timothée Mazzucotelli). Issue-uv#8148
  • Don't pass --python python to uv, which requires a python exec in the PATH (331db66 by Timothée Mazzucotelli). Issue-40
  • Make it so that linters see the make script (4989d1e by Timothée Mazzucotelli).

Code Refactoring

  • Always disable re-sync when using uv run through make (3fe244b by Timothée Mazzucotelli).
  • Remove default PDM settings from pyproject.toml, use default pth-type editable installs (d6ef6f8 by Timothée Mazzucotelli).
  • Declare dev-deps using PEP 735 (79f05ef by Timothée Mazzucotelli). Issue-42
  • Improve experience for Windows users (ece7662 by Blair Conrad). PR-33

1.2.1

17 Oct 15:14
Compare
Choose a tag to compare

1.2.1 - 2024-10-17

Compare with 1.2.0

Bug Fixes

  • Also remove Gitpod badge since we removed configuration (65cc91a by Timothée Mazzucotelli).
  • Only add force parameter to docs-deploy duty when insiders is enabled (8df12ae by Timothée Mazzucotelli).
  • Always fetch the whole Git history, needed to build the current project in non-editable mode with an up-to-date version (f52522e by Timothée Mazzucotelli).

1.2.0

12 Oct 15:38
Compare
Choose a tag to compare

1.2.0 - 2024-07-25

Compare with 1.1.5

Merge upstream

Features

  • Allow forcing docs deployment (b8f0b63 by Timothée Mazzucotelli).

Code Refactoring

  • Enable PyO3 ABI3 forward compatibility when installing deps (c391679 by Timothée Mazzucotelli).
  • Drop support for Python 3.8, start testing on Python 3.14 (f24adfe by Timothée Mazzucotelli).
  • Use newest uv features, uv run --no-sync and uv sync --no-editable (ad2ab81 by Timothée Mazzucotelli).
  • More uses of uv in docs (0e3300e by Timothée Mazzucotelli).
  • Remove GitPod configuration (977fe75 by Timothée Mazzucotelli).

Bug Fixes

  • Use uv to fix pip installs breaking system Python in GHA (b86d3e9 by Timothée Mazzucotelli).

1.1.5

05 Oct 12:12
Compare
Choose a tag to compare

1.1.5 - 2024-07-25

Compare with 1.1.3

Merge upstream

Bug Fixes

  • Fix make help message indentation (addb51e by Timothée Mazzucotelli).
  • Invalidate uv cache based on pyproject.toml (b78ce88 by Timothée Mazzucotelli).
  • Better flush help message for make script (fb2d373 by Timothée Mazzucotelli).
  • Better handle gh command error (when fetching "Documentation" category ID for discussions) (896dfb3 by Timothée Mazzucotelli).
  • Disallow overrides when getting Git remote in docs-deploy duty (cb0135b by Timothée Mazzucotelli).

Code Refactoring

  • Upgrade setup-uv action version (cc2c350 by Timothée Mazzucotelli).
  • Upgrade gh-release action version (d26e9fa by Timothée Mazzucotelli).
  • Update ci and release workflows (4692788 by Timothée Mazzucotelli).
  • Improve clean command (d4dfab7 by Timothée Mazzucotelli).
  • Enable Git revision date docs plugin, remove Git committers plugin (vendor lock-in, requires GitHub token) (c4907eb by Timothée Mazzucotelli).
  • Don't show source code in docs when insiders (5c57d92 by Timothée Mazzucotelli).
  • Clean up check duty (pre tasks) (2e4dd5b by Timothée Mazzucotelli).
  • Use higher-level uv commands (bf3c328 by Timothée Mazzucotelli).

1.1.4

25 Jul 16:14
Compare
Choose a tag to compare

1.1.4 - 2024-07-25

Compare with 1.1.3

Merge upstream

  • Add feedback system using Giscus (a69ab13 by Timothée Mazzucotelli).
  • Rephrase annoucement (bc48d13 by Timothée Mazzucotelli).
  • Add note about lower sponsorships (6a2d804 by Timothée Mazzucotelli).
  • Add docs update and change request issue templates (8f41407 by Timothée Mazzucotelli). Issue-27
  • Fix make script to be compatible with Python < 3.10 (795f39f by Timothée Mazzucotelli).
  • Update contributing docs (mention make script instead of Makefile) (7e76e47 by Timothée Mazzucotelli). Issue-28
  • Make sure to print errors in case of failure of make command (54696f3 by Timothée Mazzucotelli). Issue-26
  • Make sure setup returns non-0 exit code when uv fails to resolve dependencies (ba5c4dc by Timothée Mazzucotelli).
  • Fix Twine dependency (5.1 has been yanked) (e022917 by Timothée Mazzucotelli).

1.1.3

18 Jun 12:13
Compare
Choose a tag to compare

1.1.3 - 2024-06-18

Compare with 1.1.2

Merge upstream

  • Include almost everything in source distributions, to help system packagers (064ffb0 by Timothée Mazzucotelli).
  • Re-include tests folder in source distributions (3d9a7e1 by Timothée Mazzucotelli).

1.1.2

25 May 17:56
Compare
Choose a tag to compare

1.1.2 - 2024-05-25

Compare with 1.1.1

Merge upstream

  • Fix calling tasks from actual Makefile (30d3bc9 by Timothée Mazzucotelli).