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

Add a link checker step in the doctests jobs and fix broken links that appear #3387

Open
agriyakhetarpal opened this issue Oct 1, 2023 · 0 comments
Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: medium To be resolved if time allows

Comments

@agriyakhetarpal
Copy link
Member

Currently, we use Lychee to check for broken links, but we ignore a lot of Sphinx-related links because of referencing files internally. Sphinx provides a linkcheck builder for this purpose that can be invoked in CI for checking links (either through a new nox session, or within the docs session using posargs, or just calling the command directly).

It might make sense to rename the Lychee workflow to something like links.yml and add a parallel job to run the above command instead of another step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy A good issue for someone new. Can be done in a few hours priority: medium To be resolved if time allows
Projects
None yet
Development

No branches or pull requests

2 participants