Be friendlier w.r.t. linkchecker.

* Add external link to tool web site.
* Make command-line copy-paste friendly in CI job definition.
* Use explicit absolute path for config file in CI job CLI invocation.

diff --git a/admin/gitlab-ci/lint.gitlab-ci.yml b/admin/gitlab-ci/lint.gitlab-ci.yml
index 6fcdf2e2d5c10eaeb0240ea64d0bdb1fc88a1a7e..d75648599f7a7f364204114965d7011e823ce0a9 100644 (file)
--- a/admin/gitlab-ci/lint.gitlab-ci.yml
+++ b/admin/gitlab-ci/lint.gitlab-ci.yml
@@ -137,7 +137,7 @@ linkchecker:
     BUILD_DIR: build-docs
   script:
     - cd $BUILD_DIR
-    - linkchecker docs/html/index.html -f ../docs/linkcheckerrc -Fxml --ignore-url html-full
+    - linkchecker docs/html/index.html -f $CI_PROJECT_DIR/docs/linkcheckerrc -Fxml --ignore-url html-full
       --ignore-url html-user --ignore-url html-lib --ignore-url .tar.gz --ignore-url _sources
       -o xml
   artifacts:

diff --git a/docs/dev-manual/documentation-generation.rst b/docs/dev-manual/documentation-generation.rst
index 77a1e1bce54e8a572c4cafebdfca558a4430049d..e3b4663d8201a9a53a93b96a0430b1124f53cc66 100644 (file)
--- a/docs/dev-manual/documentation-generation.rst
+++ b/docs/dev-manual/documentation-generation.rst
@@ -113,7 +113,8 @@ LaTeX
   Also requires ImageMagick for converting graphics file formats.
 
 linkchecker
-  The linkchecker program is used together with the linkcheckerrc file to ensure
+  `linkchecker <http://wummel.github.io/linkchecker/>`__ is used together with the
+  :file:`docs/linkcheckerrc` file to ensure
   that all the links in the documentation can be resolved correctly.
 
 documentation exported from source files