Be stricter when building docuemntation

Fixes mne-tools#978
hoechenberger · Jul 31, 2024 · 03eca1b · 03eca1b
1 parent 2e9a619
commit 03eca1b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/build-docs.sh b/docs/build-docs.sh
@@ -15,4 +15,5 @@ python $STEP_DIR/source/settings/gen_settings.py
 
 echo "Building the documentation …"
 cd $STEP_DIR
-mkdocs build
+mkdocs build --strict
+
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -192,3 +192,11 @@ markdown_extensions:
         permalink: true  # Add paragraph symbol to link to current headline
     - pymdownx.tabbed:
         alternate_style: true
+
+validation:
+  # Everything set to "warn" will cause an error when building in strict mode with
+  # mkdocs build --strict
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn