-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Check anchor links #1500
Comments
There's some quirk by which ehrQL anchor links don't get picked up by lychee. |
As one example of the ehrQL failures, this There's a bit of complication with the ehrQL fragments. After a bit of thinking, I suspect that the problem might be that the fragment identifier is in an autogenerated file that's then included by the Markdown file that represents an actual page. If the fragment checker looks, it won't find it in the "page" Markdown. Easiest way to tell would be to create two minimal test files to reproduce the issue. That's then an underlying issue of lychee not following the not-really-standard includes. Other ideas that are probably not to blame
|
We've fixed most of them, but we can't easily enable the check without some kind of solution for the false positives from the ehrQL documentation. Maybe it's worth looking around lychee's documentation and code, or even opening a lychee issue for not checking "included" files if one's not open. |
As a workaround, MkDocs might be smarter at catching the links that lychee can't correctly resolve; see comment in the PR that fixes most of these links. If we can get rid of all the other MkDocs warnings, then we could check these with MkDocs instead. |
MkDocs 1.6.0 now helpfully checks these, as does lychee, so we should fix those that are broken.
The text was updated successfully, but these errors were encountered: