Skip to content

DX: check links with lychee - #321

Merged
redeboer merged 37 commits into
mainfrom
dependabot/lock-0b04a976c8
Nov 12, 2026
Merged

redeboer merged 37 commits into
mainfrom
dependabot/lock-0b04a976c8

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

🖱️ Developer experience

  • linkcheck runs lychee over all repository sources instead of the Sphinx linkcheck builder, so it also checks notebooks, workflows and configuration files and verifies anchors.
  • Docstrings and reStructuredText are formatted with docstrfmt as a pre-commit hook.
  • The .envrc activates the environment with direnv's layout uv instead of running uv sync manually.

📝 Documentation

  • The developer guide and the architectural decision records are no longer hard-wrapped, use GitHub-style alerts, and link to current URLs.

🔨 Maintenance

  • Read the Docs installs the doc dependency group with its native uv support instead of a custom Pixi install script, and fails the build on Sphinx warnings.
  • ADR notebooks skip sphinx-codeautolink instead of capping its version.

Squash commit messages

* DOC: unwrap developer guide and ADRs and update links
* DX: activate environment with direnv layout uv
* DX: format docstrings with docstrfmt
* MAINT: build Read the Docs with its native uv support
* MAINT: skip codeautolink in ADR notebooks

@dependabot dependabot Bot added the ⬆️ Lock This PR upgrades the lock files label Nov 5, 2026
@redeboer redeboer changed the title MAINT: bump the lock group with 8 updates MAINT: upgrade lock files Nov 5, 2026
@redeboer
redeboer self-requested a review November 5, 2026 12:50
@redeboer
redeboer marked this pull request as draft November 5, 2026 22:39
@redeboer
redeboer force-pushed the dependabot/lock-0b04a976c8 branch 3 times, most recently from dd98094 to 627a234 Compare November 6, 2026 21:43
@redeboer
redeboer force-pushed the dependabot/lock-0b04a976c8 branch from 627a234 to 87a7510 Compare November 7, 2026 09:17
@redeboer redeboer changed the title MAINT: upgrade lock files DX: check links with lychee Nov 9, 2026
@redeboer redeboer added 🖱️ DX Improvements to the Developer Experience 📝 Docs Improvements or additions to documentation 🔨 Maintenance Maintenance and upkeep improvements labels Nov 9, 2026
@redeboer
redeboer force-pushed the dependabot/lock-0b04a976c8 branch from bd4a3dd to 1babfea Compare November 11, 2026 15:48
@redeboer
redeboer marked this pull request as ready for review November 12, 2026 06:50
@redeboer
redeboer merged commit d3ffeaf into main Nov 12, 2026
24 checks passed
@redeboer
redeboer deleted the dependabot/lock-0b04a976c8 branch November 12, 2026 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📝 Docs Improvements or additions to documentation 🖱️ DX Improvements to the Developer Experience ⬆️ Lock This PR upgrades the lock files 🔨 Maintenance Maintenance and upkeep improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants