From c50fa7bb4abfb6b146be400562839d626a57e052 Mon Sep 17 00:00:00 2001 From: "M. Eric Irrgang" Date: Fri, 27 Mar 2020 08:48:37 +0000 Subject: [PATCH] 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. --- admin/gitlab-ci/lint.gitlab-ci.yml | 2 +- docs/dev-manual/documentation-generation.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/admin/gitlab-ci/lint.gitlab-ci.yml b/admin/gitlab-ci/lint.gitlab-ci.yml index 6fcdf2e2d5..d75648599f 100644 --- 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 77a1e1bce5..e3b4663d82 100644 --- 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 `__ 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 -- 2.22.0