From 67e943adf24b72677534d1e80e662e2cb330b65f Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Wed, 17 Apr 2024 12:19:33 +0200
Subject: [PATCH] Rework link checking
- Dockerfile: Update html-proofer-plugin from version 0.8.0 to current 1.2.1
- The new version provides functionality, we want, e.g., specification of "ignore_urls"
- mkdocs.yaml: Adjust settings for html-proofer-plugin
- raise error after all urls have been checked
- specifiy urls to be ignored
- enable validation of external urls
---
Dockerfile | 2 +-
doc.zih.tu-dresden.de/mkdocs.yml | 12 +++++++++---
doc.zih.tu-dresden.de/util/check-links.sh | 1 +
3 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/Dockerfile b/Dockerfile
index 5755c2b76..4b11d8828 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -6,7 +6,7 @@ SHELL ["/bin/bash", "-c"]
# Base #
########
-RUN pip install mkdocs>=1.1.2 mkdocs-material==8.5.11 mkdocs-htmlproofer-plugin==0.8.0 mkdocs-video==1.3.0
+RUN pip install mkdocs>=1.1.2 mkdocs-material==8.5.11 mkdocs-htmlproofer-plugin==1.2.1 mkdocs-video==1.3.0
##########
# Linter #
diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml
index fce102bcd..de4fc725f 100644
--- a/doc.zih.tu-dresden.de/mkdocs.yml
+++ b/doc.zih.tu-dresden.de/mkdocs.yml
@@ -229,14 +229,20 @@ plugins:
# Toggle via env. var. ENABLED_HTMLPROOFER=false
enabled: !ENV [ENABLED_HTMLPROOFER, True]
# Check URLs before serving. Build fails in case of bad URLs.
- raise_error: True
+ # raise_error: !ENV [ENABLED_HTMLPROOFER_RE, False]
+ # raise_error_after_finish: True
# Ignore errors
#raise_error_excludes:
# 504: ['https://www.mkdocs.org/']
+ # 405: ['https://jupyterhub.hpc.tu-dresden.de/']
+ ignore_urls:
+ - mailto:hpc-support@tu-dresden.de
+ - https://jupyterhub.hpc.tu-dresden.de/*
+ skip_downloads: True
# Toggle validating external URLs
- validate_external_urls: False
+ validate_external_urls: True
# Validate the entire rendered template, slow!
- validate_rendered_template: True
+ #validate_rendered_template: True
- mkdocs-video:
is_video: True
diff --git a/doc.zih.tu-dresden.de/util/check-links.sh b/doc.zih.tu-dresden.de/util/check-links.sh
index ab4fe5275..05a1e6923 100755
--- a/doc.zih.tu-dresden.de/util/check-links.sh
+++ b/doc.zih.tu-dresden.de/util/check-links.sh
@@ -5,5 +5,6 @@
set -eo pipefail
export ENABLED_HTMLPROOFER=true
+cd doc.zih.tu-dresden.de
mkdocs build
rm -rf public
--
GitLab