Skip to content

ENH: Add lychee link checker#954

Open
axel-grc wants to merge 1 commit into
RTKConsortium:mainfrom
axel-grc:lychee
Open

ENH: Add lychee link checker#954
axel-grc wants to merge 1 commit into
RTKConsortium:mainfrom
axel-grc:lychee

Conversation

@axel-grc

@axel-grc axel-grc commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator

following ITK PR InsightSoftwareConsortium/ITK#5377

Close #942

@SimonRit SimonRit left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with me, I just have comments to potentially improve it

Comment thread utilities/lychee.toml
# Limit lychee's recursive scan to documentation-style file extensions;
# skipping the vendored ThirdParty trees keeps run time tractable and
# avoids vendored README links that are not maintained by ITK.
extensions = ["md", "rst", "txt", "html"]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not test links in .h and .cxx files?

Comment thread utilities/lychee.toml
@@ -0,0 +1,60 @@
# Configuration for Utilities/Maintenance/check-links.sh.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When is this executed? The PR didn't trigger any check it seems.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like we can easily run it with pre-commit.

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.

Add lychee link checker

3 participants