Add a link checker step in the doctests jobs and fix broken links that appear #3387
Labels
difficulty: easy
A good issue for someone new. Can be done in a few hours
priority: medium
To be resolved if time allows
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 alinkcheck
builder for this purpose that can be invoked in CI for checking links (either through a newnox
session, or within thedocs
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.The text was updated successfully, but these errors were encountered: