Skip to content

DX: check links with lychee - #532

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

redeboer merged 47 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. poe all now runs it right after style.
  • Documentation can use GitHub-style alerts such as > [!TIP], which also render on GitHub, through the MyST alert extension (myst-parser>=5.1).
  • Dependabot pull requests are assigned to a maintainer automatically.

🔨 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.
  • The 75% coverage threshold is set once through fail_under in the coverage configuration instead of in the pytest arguments and codecov.yml. The Codecov configuration drops its default settings, and the patch status is informational.
  • Docstrings are formatted with docstrfmt.

📝 Documentation

  • Docstrings link more SymPy, QRules and Sphinx objects through cross-references.

Squash commit messages

* DOC: improve Sphinx cross-references
* DX: set Dependabot assignee
* DX: support GitHub-style alerts in the documentation
* MAINT: build Read the Docs with its native uv support
* MAINT: define coverage threshold in coverage configuration
* MAINT: format docstrings with docstrfmt
* MAINT: make Codecov patch status informational

@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 2 times, most recently from 73fcbc4 to 8753b69 Compare November 6, 2026 21:45
@redeboer
redeboer force-pushed the dependabot/lock-0b04a976c8 branch from 8753b69 to 88f151f 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 🔨 Maintenance Maintenance and upkeep improvements 🖱️ DX Improvements to the Developer Experience labels Nov 9, 2026
@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Nov 11, 2026
@redeboer
redeboer marked this pull request as ready for review November 11, 2026 15:05
@redeboer
redeboer merged commit 653cf67 into main Nov 12, 2026
35 checks passed
@redeboer
redeboer deleted the dependabot/lock-0b04a976c8 branch November 12, 2026 14:42
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