Add link checker

vizro-ai/.readthedocs.yaml

@@ -11,6 +11,6 @@ build:
     python: "3.11"
   commands:
     - pip install hatch
-    - cd vizro-ai/ && hatch run docs:mkdocs build --strict
+    - cd vizro-ai/ && hatch run docs:build && hatch run docs:link-check
     - mkdir --parents $READTHEDOCS_OUTPUT
     - mv vizro-ai/site/ $READTHEDOCS_OUTPUT/html

vizro-ai/hatch.toml

@@ -51,7 +51,13 @@ dependencies = [
   "mkdocstrings[python]"
 ]
 detached = true
-scripts = {serve = "mkdocs serve --strict"}
+
+[envs.docs.scripts]
+serve = "mkdocs serve --strict"
+build = "mkdocs build --strict"
+# Disable warnings on the linkcheck so that HTTP redirects are accepted. We could ignore only that warning and specify
+# more advanced settings using a linkcheckerrc config file.
+link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1"
 
 [envs.lint]
 dependencies = [

vizro-core/.readthedocs.yaml

@@ -11,6 +11,6 @@ build:
     python: "3.11"
   commands:
     - pip install hatch
-    - cd vizro-core/ && hatch run docs:mkdocs build --strict
+    - cd vizro-ai/ && hatch run docs:build && hatch run docs:link-check
     - mkdir --parents $READTHEDOCS_OUTPUT
     - mv vizro-core/site/ $READTHEDOCS_OUTPUT/html

vizro-core/hatch.toml

@@ -69,7 +69,13 @@ dependencies = [
   "mkdocstrings[python]"
 ]
 detached = true
-scripts = {serve = "mkdocs serve --strict"}
+
+[envs.docs.scripts]
+serve = "mkdocs serve --strict"
+build = "mkdocs build --strict"
+# Disable warnings on the linkcheck so that HTTP redirects are accepted. We could ignore only that warning and specify
+# more advanced settings using a linkcheckerrc config file.
+link-check = "linkchecker site --check-extern --no-warnings --ignore=404.html --ignore-url=127.0.0.1"
 
 [envs.lint]
 dependencies = [