Skip to content

CI: add lychee link check on built docs - #889

Merged
jorenham merged 1 commit into
numpy:mainfrom
InessaPawson:lychee
Oct 2, 2026
Merged

jorenham merged 1 commit into
numpy:mainfrom
InessaPawson:lychee

Conversation

@InessaPawson

Copy link
Copy Markdown
Member

Adds a links workflow that runs https://github.com/lycheeverse/lychee against the rendered MkDocs output. Closes #473.

Checking the built site instead of the markdown sources means links that only exist after rendering (magiclink shorthand, autorefs, mkdocstrings) are covered, which answers the question in #473 (comment).

site/404.html is excluded because MkDocs gives it root-relative /numtype/... links that only resolve on the deployed site.

Tested locally with uv run --only-group=docs mkdocs build followed by lychee:

🔍 273 Total (in 1s 582ms) 🔗 88 Unique ✅ 266 OK 🚫 0 Errors 👻 1 Excluded ⛔ 6 Unsupported 🔀 4 Redirects

The scheduled run won't fire on a fork PR, so this needs a workflow_dispatch after merge to see it in action.

@jorenham
jorenham merged commit 12791e7 into numpy:main Oct 2, 2026
23 checks passed
@jorenham

jorenham commented Oct 2, 2026

Copy link
Copy Markdown
Member

Thanks!

@InessaPawson
InessaPawson deleted the lychee branch October 2, 2026 23:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add link check action

2 participants