Skip to content
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

LinkChecker validation inconsistent between Markdown and HTML #671

Open
ChrisZYJ opened this issue Nov 1, 2024 · 2 comments
Open

LinkChecker validation inconsistent between Markdown and HTML #671

ChrisZYJ opened this issue Nov 1, 2024 · 2 comments

Comments

@ChrisZYJ
Copy link
Contributor

ChrisZYJ commented Nov 1, 2024

#669 fixes a broken link by changing running.md#restarting-cases to md_running.html#restarting_cases. However, this change fails the CI test "LinkChecker / markdown-link-check (push)". Additionally, the LinkChecker appears to incorrectly validate links like references.md#Toro13, marking them as valid despite leading to non-existent pages (this applies to all reference links).

Maybe the LinkChecker works properly with Markdown files but doesn't correctly validate links in the Doxygen-generated HTML files.

@sbryngelson
Copy link
Member

This seems to be the case. We may need to tell the linkchecker to ignore these files or find another way around it. It would be good to know if the documentation has dead links.

@sbryngelson
Copy link
Member

I think the solution is to build the full documentation via ./mfc.sh build -t documentation and then check the files in CI for broken links.

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

No branches or pull requests

2 participants