Skip to content

CI: Check html links for doc#4178

Draft
hdiethelm wants to merge 1 commit into
LinuxCNC:masterfrom
hdiethelm:ci_htmltest
Draft

CI: Check html links for doc#4178
hdiethelm wants to merge 1 commit into
LinuxCNC:masterfrom
hdiethelm:ci_htmltest

Conversation

@hdiethelm

@hdiethelm hdiethelm commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Check HTML links in docs in CI

There are a few broken links, so continue-on-error is set to true for now.

This is just one tool of many. I tried:

@grandixximo

Copy link
Copy Markdown
Contributor

LGTM. htmltest in a container works well and keeps doc builds free of new dev dependencies.

One note for later: we already have an in-tree link checker (docs/src/checkref) built on w3c-linkchecker, but it has been a silent no-op for a while since recent w3c-linkchecker refuses file:// URIs, so it validates nothing. This CI check is a real improvement over that.

If we ever want something more actively maintained than htmltest, lychee (Rust, async) is excellent. I'd keep it CI-only via Docker though: there is no Debian apt package for it, so it is not a good fit for the local make checkref target where we rely on apt-installable deps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants