feat: docs-linkcheck added for sphinx.mk

Author: jensens

CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.1 (unreleased)
+
+- Features: Add `docs-linkcheck` to check for broken links in the sphinx documentation.
+
 ## 1.3.0 (2025-09-03)
 
 - Introduce testargs for pytest to have more control over the test and pass it args.

src/mxmake/topics/docs/sphinx.mk

@@ -11,6 +11,9 @@
 #:description = Rebuild Sphinx documentation on changes, with live-reload in
 #:  the browser using `sphinx-autobuild`.
 #:
+#:[target.docs-linkcheck]
+#:description = Run Sphinx linkcheck to verify external links in documentation.
+#:
 #:[target.docs-clean]
 #:description = Removes generated docs.
 #:
@@ -22,6 +25,10 @@
 #:description = Documentation generation target folder.
 #:default = docs/html
 #:
+#:[setting.DOCS_LINKCHECK_FOLDER]
+#:description = Documentation linkcheck output folder.
+#:default = docs/linkcheck
+#:
 #:[setting.DOCS_REQUIREMENTS]
 #:description = Documentation Python requirements to be installed (via pip).
 #:default =
@@ -52,6 +59,11 @@ docs-live: $(DOCS_TARGET) $(DOCS_TARGETS)
 	@echo "Rebuild Sphinx documentation on changes, with live-reload in the browser"
 	@$(SPHINX_AUTOBUILD_BIN) $(DOCS_SOURCE_FOLDER) $(DOCS_TARGET_FOLDER)
 
+.PHONY: docs-linkcheck
+docs-linkcheck: $(DOCS_TARGET) $(DOCS_TARGETS)
+	@echo "Run Sphinx linkcheck"
+	@$(SPHINX_BIN) -b linkcheck $(DOCS_SOURCE_FOLDER) $(DOCS_LINKCHECK_FOLDER)
+
 .PHONY: docs-dirty
 docs-dirty:
 	@rm -f $(DOCS_TARGET)