Release v0.6.1

TopMark v0.6.1 — Release Notes

📝 This release focuses on docstring quality and link validation across the codebase and documentation.

✨ Added

• Docstring link checker: new tools/check_docstring_links.py

  • Enforces reference-style links for internal objects.
  • Flags raw URLs in docstrings.
  • Reports accurate line/range info, with code-region masking.
  • CLI flags: --stats and --ignore-inline-code.

• Makefile targets:

  • docstring-links, links, links-src, links-all.
  • Centralized check-lychee gate for link validation.

🔧 Changed

• MkDocs build:

  • strict: true and link validation enabled → builds now fail on broken internal links.

• Docstrings / cross-references:

  • Converted internal references to mkdocstrings+autorefs style:
    • [`pkg.mod.Object`][] or [Text][pkg.mod.Object]
  • Prefer fully-qualified names for clarity.

• Docs structure:

  • Normalized mkdocstrings blocks (tidy-ups and consistency).

🐛 Fixed

• README:
  • Corrected the “Adding & updating headers with topmark” link → now points to docs/usage/commands/check.md.

🧪 Tooling

• Lychee integration:

  • Adopted Lychee for link checks (local + CI).
  • Scoped pre-commit hooks for faster validation.

• Testing:

  • Raised pytest minimum version to >=8.0 (via test extra).

• Refactors:

  • Minor cleanups:
    • Renamed local import alias in filetype registry.
    • Typing improvements.

📦 Installing / Upgrading

pip install -U topmark

🙌 Thanks

Thanks to contributors who flagged broken references and helped strengthen docs quality and reproducibility.

---

Links

• PyPI: https://pypi.org/project/topmark/
• Docs: https://shutterfreak.github.io/topmark/
• Changelog: see CHANGELOG.md in the repo
• Full Changelog: v0.6.0...v0.6.1