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

Doccheck to check local links #2130

Closed
mortenpi opened this issue May 24, 2023 · 0 comments · Fixed by #2187
Closed

Doccheck to check local links #2130

mortenpi opened this issue May 24, 2023 · 0 comments · Fixed by #2187

Comments

@mortenpi
Copy link
Member

mortenpi commented May 24, 2023

Right now, we can check remote links with linkcheck, but not local links. We will warn in HTMLWriter if a local link is broken (e.g. an image link pointing a non-existent file in src/), but you can't turn those into errors.

I think we should just add a new doccheck for this that performs the check a little bit earlier (at the same time as linkcheck I guess). This would allow users to catch errors where you have e.g. local images links in your manual etc. that can not be resolved.

Would be good to get this into 1.0, so that we could enable this by default in strict mode.

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

Successfully merging a pull request may close this issue.

1 participant