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

potential solution to broken links in the docs #3240

Open
shimwell opened this issue Jan 5, 2025 · 0 comments
Open

potential solution to broken links in the docs #3240

shimwell opened this issue Jan 5, 2025 · 0 comments

Comments

@shimwell
Copy link
Member

shimwell commented Jan 5, 2025

From time to time URL links in the docs result in 404 not found errors. This happens when URLs are moved.

sphinx-build offers a linkcheck function that runs though the docs checking for broken links (both internal and external) which we can run with either of the following commands in the docs folder

sphinx-build -M linkcheck . _build

or

make linkcheck

Currently the report shows a few broken links which we can then manually fix.

We could run this check periodically or in the CI

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

No branches or pull requests

1 participant