Add lychee-based linkcheck workflow.

Author: pp-mo

.github/workflows/ci-linkchecks.yml

@@ -0,0 +1,29 @@
+name: Linkcheck
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "00 06 * * 1-5"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write # required for peter-evans/create-issue-from-file
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          fail: false
+          args: "--verbose './docs/**/*.rst' './docs/**/*.inc'"
+
+      - name: Create Issue From File
+        if: steps.lychee.outputs.exit_code != 0
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

.lycheeignore

@@ -0,0 +1,33 @@
+# DEAD : legacy in various old whatsnews
+https://biggus.readthedocs.io
+
+# unkown problem, works in browser : used in further_topics/ugrid/data_model
+https://doi.org/10.3390/jmse2010194
+
+# DEAD, todo:remove, used in docs/src/userguide/plotting_a_cube.rst
+https://effbot.org
+
+# DEAD, todo:remove, used in docs/src/further_topics/ugrid/data_model.rst
+https://ibm-design-language.eu-de.mybluemix.net/design/language/resources/color-library
+
+# DEAD, legacy in whatsnew/1.4.rst
+https://geoport.whoi.edu/thredds/dodsC/bathy/gom15
+
+# catch (at least) github userids, of which many in whatsnews, too many --> "too many requests" failures
+https://github.com/[^/]*$
+
+# nonfunctional example, used in docs/src/developers_guide/gitwash/development_workflow.rst
+https://github.com/your-user-name/iris
+
+# problem with bad certificate (review sometime?)
+https://scitools.github.com/cartopy
+
+# legacy ref in whatsnew/3.0.rst
+https://stickler-ci.com
+
+# unkown problem, works in browser : used in docs/src/index.rst
+https://www.flaticon.com
+
+# DEAD, todo:remove, used in docs/src/userguide/plotting_a_cube.rst
+https://www.personal.psu.edu/cab38/ColorBrewer/ColorBrewer_updates.html
+

docs/src/further_topics/dask_best_practices/index.rst

@@ -44,13 +44,13 @@ CPU available. This interacts badly with Dask:
 * NumPy will generate enough threads to use all available CPUs even
   if Dask is deliberately configured to only use a subset of CPUs. The
   resulting sharing of CPUs between threads greatly reduces performance.
-* `Dask is already designed to parallelise with NumPy arrays <https://docs
-  .dask.org/en/latest/array.html>`_, so adding NumPy's 'competing' layer of
-  parallelisation could cause unpredictable performance.
+* `Dask is already designed to parallelise with NumPy arrays
+  <https://docs.dask.org/en/latest/array.html>`_, so adding NumPy's 'competing' layer
+  of parallelisation could cause unpredictable performance.
 
 Therefore it is best to prevent NumPy performing its own parallelisation, `a
-suggestion made in Dask's own documentation <https://docs.dask
-.org/en/stable/array-best-practices.html#avoid-oversubscribing-threads>`_.
+suggestion made in Dask's own documentation
+<https://docs.dask.org/en/stable/array-best-practices.html#avoid-oversubscribing-threads>`_.
 The following commands will ensure this in all scenarios:
 
 in Python...
@@ -158,8 +158,8 @@ NetCDF Files
 
 NetCDF files can include their own chunking specification. This is either
 specified when creating the file, or is automatically assigned if one or
-more of the dimensions is `unlimited <https://www.unidata.ucar
-.edu/software/netcdf/docs/unlimited_dims.html>`_.
+more of the dimensions is
+`unlimited <https://www.unidata.ucar.edu/software/netcdf/docs/unlimited_dims.html>`_.
 Importantly, netCDF chunk shapes are **not optimised for Dask
 performance**.
 

docs/src/userguide/glossary.rst

@@ -188,7 +188,7 @@ Glossary
 
    Standard Name
         A name describing a :term:`phenomenon`,  one from a fixed list
-        defined at `CF Standard Names <https://cfconventions.org/standard-names.html>`_.
+        defined at `CF Standard Names <https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html>`_.
 
         | **Related:** :term:`Long Name` **|** :term:`Cube`
         | **More information:** :doc:`iris_cubes`

docs/src/whatsnew/2.3.rst

@@ -29,8 +29,7 @@ Features
 .. admonition:: Climatological Coordinate Support
 
   Iris can now load, store and save `NetCDF climatological coordinates
-  <https://cfconventions.org/Data/cf-conventions/cf-conventions-1
-  .7/cf-conventions.html#climatological-statistics>`_. Any cube time
+  <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#climatological-statistics>`_. Any cube time
   coordinate can be marked as a climatological time axis using the boolean
   property: ``climatological``. The climatological bounds are stored in the
   coordinate's ``bounds`` property.
@@ -41,9 +40,8 @@ Features
   coordinate's ``bounds`` property are written to a NetCDF boundary variable
   called '<coordinate-name>_bounds'.  These are in place of a standard
   'bounds' attribute and accompanying boundary variable. See below
-  for an `example adapted from CF conventions <https://cfconventions
-  .org/Data/cf-conventions/cf-conventions-1.7/cf-conventions
-  .html#climatological-statistics>`_:
+  for an
+  `example adapted from CF conventions <https://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/cf-conventions.html#climatological-statistics>`_:
 
     .. code-block:: none
 
@@ -116,8 +114,7 @@ Features
 
 * New coordinate system: :class:`iris.coord_systems.Geostationary`,
   including load and save support, based on the `CF Geostationary projection
-  definition <https://cfconventions
-  .org/cf-conventions/cf-conventions.html#_geostationary_projection>`_.
+  definition <https://cfconventions.org/cf-conventions/cf-conventions.html#_geostationary_projection>`_.
 
 * :class:`iris.coord_systems.VerticalPerspective` can now be saved to and
   loaded from NetCDF files.
@@ -164,8 +161,7 @@ Bugs Fixed
   points.
 
 * :class:`iris.coord_systems.VerticalPerspective` coordinate system now uses
-  the `CF Vertical perspective definition <https://cfconventions
-  .org/cf-conventions/cf-conventions.html#vertical-perspective>`_; had been
+  the `CF Vertical perspective definition <https://cfconventions.org/cf-conventions/cf-conventions.html#vertical-perspective>`_; had been
   erroneously using Geostationary.
 
 * :class:`~iris.coords.CellMethod` will now only use valid 
@@ -227,8 +223,7 @@ Internal
 ========
 
 * Iris now supports Proj4 up to version 5, but not yet 6 or beyond, pending
-  `fixes to some cartopy tests <https://github
-  .com/SciTools/cartopy/pull/1289#pullrequestreview-272774087>`_.
+  `fixes to some cartopy tests <https://github.com/SciTools/cartopy/pull/1289#pullrequestreview-272774087>`_.
 
 * Iris now requires Dask >= 1.2 to allow for improved coordinate equality
   checks.
@@ -238,7 +233,7 @@ Documentation
 =============
 
 * Adopted a
-  `new colour logo for Iris <https://github.com/SciTools/iris/blob/main/docs/src/_static/Iris7_1_trim_100.png>`_
+  `new colour logo for Iris <https://github.com/SciTools/iris/blob/v2.3.0/docs/iris/src/_static/Iris7_1_trim_100.png>`_
 
 * Added a gallery example showing how to concatenate NEMO ocean model data,
   see :ref:`sphx_glr_generated_gallery_oceanography_plot_load_nemo.py`.

docs/src/why_iris.rst

@@ -11,7 +11,7 @@ giving you a powerful, format-agnostic interface for working with your data.
 It excels when working with multi-dimensional Earth Science data, where tabular
 representations become unwieldy and inefficient.
 
-`CF Standard names <https://cfconventions.org/standard-names.html>`_,
+`CF Standard names <https://cfconventions.org/Data/cf-standard-names/current/build/cf-standard-name-table.html>`_,
 `units <https://github.com/SciTools/cf_units>`_, and coordinate metadata
 are built into Iris, giving you a rich and expressive interface for maintaining
 an accurate representation of your data. Its treatment of data and