Docs: use linkcheck build to verify external links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
As part of our release process we manually test links e.g. to the relevant sections in the CF conventions. This check can be largely automated (all but fixing incorrect links) by running the sphinx.builders.linkcheck builder which detects broken links and raises warnings if they are found.
Addressing this will help towards automation of the release process (see #134).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by locating the Sphinx documentation build configuration and the release-process references, then review the linkcheck builder documentation. Done means the release documentation build checks external links and reports broken links as warnings, without requiring manual link testing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100