Per METplus#3247, adding automated link checking in conjunction with new repo dtcenter/metplus-action-linkcheck

Author: jprestop

.github/workflows/linkcheck_pull_request.yml

@@ -0,0 +1,15 @@
+name: linkcheck-pr
+on:
+  pull_request:
+    paths:
+      - 'docs/**'
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtcenter/metplus-action-linkcheck@v1
+        with:
+          fail-on-broken-links: 'true'
+          upload-artifact: 'true'

.github/workflows/linkcheck_scheduled.yml

@@ -0,0 +1,15 @@
+name: linkcheck-scheduled
+on:
+  schedule:
+    - cron: '0 6 * * 1'
+  workflow_dispatch: {}
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtcenter/metplus-action-linkcheck@v1
+        with:
+          fail-on-broken-links: 'true'
+	  

docs/conf.py

@@ -97,7 +97,29 @@
 numfig_format = {
         'figure': 'Figure %s',
         }
-    
+
+# -- linkcheck builder configuration ----------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
+
+linkcheck_timeout = 10
+linkcheck_retries = 2
+linkcheck_workers = 8
+
+linkcheck_ignore = [
+    # add regex patterns for URLs that should be skipped, e.g.:
+    # r'https://dtcenter\.org/.*',   # if this site blocks automated requests
+    # r'https://matplotlib\.org/.*',        # occasionally rate-limits automated clients
+    # r'https://scitools\.org\.uk/cartopy/.*',  # occasionally slow
+    # r'https://doi\.org/.*',               # DOI redirectors often 403 non-browser requests
+]
+
+linkcheck_allowed_redirects = {
+    # map of regex -> regex for redirects that are fine to follow
+}
+
+linkcheck_anchors = True
+linkcheck_anchors_ignore = ['^!']
+
 # -- Export variables --------------------------------------------------------
 
 rst_epilog = """