doc: add linkcheck build target

Signed-off-by: Xavier Delaruelle <[email protected]>

Author: xdelaruelle

doc/Makefile

@@ -89,6 +89,9 @@ ifneq ($(builddoc),p)
 $(SOURCE_DIR)/version.py: $(SOURCE_DIR)/version.py.in ../version.inc
 	$(translate-in-script)
 
+linkcheck: $(SOURCE_DIR)/version.py
+	$(SPHINXBUILD) $(SPHINXOPTS) -b linkcheck "$(SOURCE_DIR)" "$(BUILD_DIR)"
+
 $(BUILD_DIR)/%.html: $(SOURCE_DIR)/%.rst $(SOURCE_DIR)/version.py
 	$(ECHO_GEN2) $(ECHO_DIR_PREFIX)$(BUILD_DIR)/*.html
 	$(SPHINXBUILD) $(SPHINXOPTS) -b html "$(SOURCE_DIR)" "$(BUILD_DIR)"

doc/source/conf.py

@@ -318,6 +318,18 @@ def get_version_release_from_git():
 ]
 
 
+# -- Options for linkcheck ------------------------------------------------
+
+linkcheck_ignore = [
+    'https://matrix.to/#',
+    'module.html#version-specifiers',
+    'tag:S,F',
+    'tag:sticky',
+]
+linkcheck_timeout = 5
+linkcheck_workers = 1
+
+
 # -- Extension interface --------------------------------------------------
 
 from sphinx import addnodes