search

MFlowCode / MFC

Exascale simulation of multiphase/physics fluid dynamics
https://mflowcode.github.io
MIT License
144 stars 67 forks source link

LinkChecker validation inconsistent between Markdown and HTML #671

Open ChrisZYJ opened 2 hours ago

ChrisZYJ commented 2 hours ago

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 commented 2 hours ago

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 commented 21 minutes ago

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.