From 48eab764273fe2e2b47ebbf08b6120d74ff11b81 Mon Sep 17 00:00:00 2001 From: Michal Nowak Date: Fri, 24 Jan 2025 11:50:49 +0100 Subject: [PATCH] Add linkcheck job --- .gitlab-ci.yml | 12 ++++++++++++ doc/arm/conf.py | 14 ++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0b4637f9b9..d386dbfbd0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -683,6 +683,18 @@ changelog: artifacts: untracked: true +linkcheck: + <<: *base_image + stage: docs + script: + - pushd doc/arm/ > /dev/null && sphinx-build -b linkcheck . linkcheck_output/ + artifacts: + paths: + - doc/arm/linkcheck_output/ + rules: + - if: '$CI_PIPELINE_SOURCE == "schedule"' + needs: [] + docs: <<: *default_triggering_rules <<: *base_image diff --git a/doc/arm/conf.py b/doc/arm/conf.py index 4f2d9e98cd..d3c27e4dc8 100644 --- a/doc/arm/conf.py +++ b/doc/arm/conf.py @@ -214,6 +214,20 @@ latex_documents = [ latex_logo = "isc-logo.pdf" +# -- Options for linkcheck ---------------------------------------------- +linkcheck_timeout = 10 +linkcheck_ignore = [ + "http://127.0.0.1", + "https://gitlab.isc.org", + "https://kb.isc.org", + "https://simpleicon.com/", + "https://www.dnssec-or-not.com/", + "https://www.flaticon.com/", + "https://www.freepik.com/", + "https://www.godaddy.com", + "https://www.icann.org", +] + # # The rst_epilog will be completely overwritten from the Makefile, # the definition here is provided purely for situations when