In my asyncio "review", I saw that somebody inserted a 404 link into the docstring. Apart from daring to do that to our docs (shame on them), existing links can break as well. SO I researched a bit and found the linkcheck build option of sphinx. We can run this like once a week. I am quite sure we have to parse the output since it doesn't break when it finds a non working link, but that shouldn't be too much work TM. From me messing around with it, we should definitely exclude our changelist file since it has too many github links and it doesn't matter too much if those break IMO.

Buildname linkcheck: https://www.sphinx-doc.org/en/master/man/sphinx-build.html

Config: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder

After a short internal discussion, we want to different test triggers:

• once/twice per month, on the whole docs
• on a PR/push, only on the changed files.