Add CI job to check hyperlinks in documentation

Co-authored-by: Martin Grzenia <martin.grzenia@iml.fraunhofer.de>
Merged-by: Martin Grzenia <martin.grzenia@iml.fraunhofer.de>

Author: swltr

.gitlab-ci.yml

@@ -18,7 +18,7 @@ workflow:
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
     - if: $CI_PIPELINE_SOURCE == "schedule"
     - if: $CI_PIPELINE_SOURCE == "web"
-      
+
 variables:
   GRADLE_OPTS: "-Dorg.gradle.daemon=false"
   DO_BUILD_CODEQUALITY_IMAGE:
@@ -100,6 +100,7 @@ build:
       - opentcs-*/build/libs/
       - opentcs-*/build/resources/
       - opentcs-*/build/tmp/
+      - opentcs-documentation/build/install/
     exclude:
       - .gradle/.tmp/**/*
       - .gradle/caches/**/*
@@ -184,6 +185,18 @@ lint-checkstyle:
     paths:
       - .gradle
 
+lint-hyperlinks:
+  stage: test
+  interruptible: true
+  image:
+    name: ghcr.io/untitaker/hyperlink:0.2.0
+    entrypoint: [""]
+  dependencies:
+    - build
+  script:
+    - echo "Checking hyperlinks in generated documentation..."
+    - hyperlink --check-anchors opentcs-documentation/build/install/
+
 lint-reuse:
   stage: test
   interruptible: true

opentcs-documentation/build.gradle

@@ -152,8 +152,8 @@ task asciidoctorReleaseNotes(type: org.asciidoctor.gradle.jvm.AsciidoctorTask) {
   // Attributes specific to the HTML output
   attributes 'webfonts': false, // Disable webfonts
              'iconfont-remote': false, // Disable remote icon fonts
+             'stylesdir': "_assets/css/", // Override the default styles directory to properly configure the use of local Font Awsome assets
              'docinfo': "${file('src/docs/release-notes/docinfo.html')}, shared" // The docinfo file references the stylesheets for fonts to use
-
 }
 
 task asciidoctorUsersGuide(type: org.asciidoctor.gradle.jvm.AsciidoctorTask) {
@@ -178,6 +178,7 @@ task asciidoctorUsersGuide(type: org.asciidoctor.gradle.jvm.AsciidoctorTask) {
              // Attributes specific to the HTML output
              'webfonts': false, // Disable webfonts
              'iconfont-remote': false, // Disable remote icon fonts
+             'stylesdir': "../_assets/css/", // Override the default styles directory to properly configure the use of local Font Awsome assets
              'docinfo': "${file('src/docs/users-guide/docinfo.html')}, shared" // The docinfo file references the stylesheets for fonts to use
 
   resources {
@@ -217,10 +218,9 @@ task asciidoctorDevelopersGuide(type: org.asciidoctor.gradle.jvm.AsciidoctorTask
              // Attributes specific to the HTML output
              'webfonts': false, // Disable webfonts
              'iconfont-remote': false, // Disable remote icon fonts
+             'stylesdir': "../../_assets/css/", // Override the default styles directory to properly configure the use of local Font Awsome assets
              'docinfo': "${file('src/docs/developers-guide/docinfo.html')}, shared" // The docinfo file references the stylesheets for fonts to use
 
-             // 'docinfo': "${file('src/docs/docinfo.html')}, shared", // doesn't seem to work
-             //'docinfodir': file('src/docs'),
   resources {
     from(sourceDir) {
       include '**/*.png'

opentcs-documentation/src/docs/developers-guide/docinfo.html

@@ -4,4 +4,3 @@
 -->
 
 <link rel="stylesheet" href="../../_assets/css/style.css">
-<link rel="stylesheet" href="../../_assets/css/font-awesome.css">

opentcs-documentation/src/docs/release-notes/docinfo.html

@@ -4,4 +4,3 @@
 -->
 
 <link rel="stylesheet" href="_assets/css/style.css">
-<link rel="stylesheet" href="_assets/css/font-awesome.css">

opentcs-documentation/src/docs/users-guide/docinfo.html

@@ -4,4 +4,3 @@
 -->
 
 <link rel="stylesheet" href="../_assets/css/style.css">
-<link rel="stylesheet" href="../_assets/css/font-awesome.css">