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.

Sign up for GitHub

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

Jump to bottom

Check validity of URLs #17

Open
jwallwork23 opened this issue Apr 20, 2024 · 1 comment
Open

Check validity of URLs #17

jwallwork23 opened this issue Apr 20, 2024 · 1 comment
Assignees
@jwallwork23
Labels
docsprint To be addressed in next documentation sprint testing Extensions and improvements to the testing infrastructure

Comments

@jwallwork23
Copy link
Member

Add a test to the CI to check that none of the URLs are out of date.

Possibly using https://pypi.org/project/LinkChecker/.
@jwallwork23 jwallwork23 added the testing Extensions and improvements to the testing infrastructure label Apr 20, 2024
@jwallwork23 jwallwork23 self-assigned this Oct 29, 2024
jwallwork23 added a commit that referenced this issue Oct 29, 2024
@jwallwork23
#17: Add link check
4a3c338
@jwallwork23 jwallwork23 mentioned this issue Oct 29, 2024
Closed
@jwallwork23 jwallwork23 moved this from Backlog to In Progress in Mesh Adaptation development board Oct 29, 2024
@jwallwork23 jwallwork23 added the docsprint To be addressed in next documentation sprint label Nov 18, 2024
@jwallwork23
Copy link
Member Author

Today I realised Sphinx already has inbuilt link checking that we could use. This can be used with

cd docs
make linkcheck

Running this locally gives many failures.

@jwallwork23 jwallwork23 moved this from In Progress to Backlog in Mesh Adaptation development board Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jwallwork23 jwallwork23

Labels
docsprint To be addressed in next documentation sprint testing Extensions and improvements to the testing infrastructure
Projects
Mesh Adaptation development board
Status: Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add workflow for checking links in docs mesh-adaptation/docs
1 participant
@jwallwork23