diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml index 638683a8..d266bb1a 100644 --- a/.github/workflows/ci-tests.yml +++ b/.github/workflows/ci-tests.yml @@ -36,13 +36,14 @@ jobs: matrix: os: ["ubuntu-latest"] python-version: ["3.11"] - session: ["doctest"] + session: ["doctest", "linkcheck"] iris-source : ["conda-forge"] include: - os: "ubuntu-latest" python-version: "3.11" session: "tests" iris-source: "conda-forge" + coverage: "--coverage" - os: "ubuntu-latest" python-version: "3.11" session: "tests" @@ -129,3 +130,7 @@ jobs: PY_VER: ${{ matrix.python-version }} run: | nox --session ${{ matrix.session }} -- --test-data-dir ${HOME}/iris-test-data/test_data + + - name: "Upload coverage report" + uses: codecov/codecov-action@v4 + if: ${{ matrix.coverage }} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 6e27a766..d70991db 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -105,6 +105,14 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False +# url link checker. Some links registering as faulty, despite being functional. +# See https://www.sphinx-doc.org/en/1.2/config.html[...] +# [...]#options-for-the-linkcheck-builder + +linkcheck_ignore = [ + "https://github.com/Scitools/iris-grib/compare" + "/c4243ae..5c314e3#diff-cf46b46880cae59e82a91c7ab6bb81ba" +] # -- Autodoc ------------------------------------------------------------------ diff --git a/docs/index.rst b/docs/index.rst index 15f18fae..d021c57d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -214,7 +214,7 @@ Getting Started To ensure all ``iris-grib`` dependencies, it is sufficient to have installed :mod:`Iris ` itself, and -`ecCodes `_ . +`ecCodes `_ . The simplest way to install is with `conda `_ , using the @@ -234,7 +234,7 @@ Development sources are hosted at ``_ . Releases ======== -For recent changes, see `Release Notes `_ . +For recent changes, see :ref:`release_notes` . Indices and tables diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index 52d7bda7..cd93f5e4 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -1,3 +1,5 @@ +.. _release_notes: + Release Notes ============= @@ -128,7 +130,7 @@ Bugs Fixed iris-grib to work with the latest versions of `iris `_, `cf-units `_, - `ecCodes `_ and + `ecCodes `_ and `cartopy `_, including casting the usage of :meth:`cf_units.Unit.date2num` as float. setting and setting the values of some missing keys using ``gribapi.GRIB_MISSING_LONG``. @@ -247,15 +249,15 @@ Bugs Fixed * `@pp-mo `_ fixed loading of grid definition template 3.90, "Space view perspective or orthographic grid", which was **broken since Iris 2.3**. This now produces data with an iris - `Geostationary `_ + `Geostationary `_ coordinate system. Prior to Iris 2.3, what is now the Iris 'Geostationary' class was (incorrectly) named "VerticalPerspective" : When that was `corrected in Iris 2.3 `_ , it broke the iris-grib loading, since the data was now incorrectly assigned the "new-style" Iris - `VerticalPerspective `_ + `VerticalPerspective `_ coordinate system, equivalent to the Cartopy - `NearsidePerspective `_ + `NearsidePerspective `_ and Proj `"nsper" `_ . The plotting behaviour of this is now **the same again as before Iris 2.3** : @@ -264,7 +266,7 @@ Bugs Fixed * `@pp-mo `_ fixed a problem where cubes were loading from GRIB 1 with a changed coordinate system, since eccodes versions >= 1.19. This resulted from a change to eccodes, which now returns a different - 'shapeOfTheEarth' parameter : see `eccodes issue ECC-811 `_ . This resulted + 'shapeOfTheEarth' parameter. This resulted in a coordinate system with a different earth radius. For backwards compatibilty, the earth radius has now been fixed to the same value as previously. However, pending further investigation, this value may be technically incorrect and we may @@ -293,8 +295,7 @@ Bugs Fixed * `@pp-mo `_ fixed a problem that caused very slow loading, and possible memory overflows, with Dask versions >= 2.0. **This requires Iris >= 2.4**, as a new minimum dependency. - ( This problem was shared with UM file access in Iris : see - https://scitools.org.uk/iris/docs/v2.4.0/whatsnew/2.4.html#bugs-fixed ). + ( This problem was shared with UM file access in Iris, fixed in Iris 2.4. `(PR#190) `_ * `@trexfeathers `_ fixed all the tests to @@ -451,7 +452,7 @@ What's new in iris-grib v0.12 :Date: 25 Oct 2017 Updated to work with -`ecCodes `_ as its +`ecCodes `_ as its interface to GRIB files. This is ECMWF's replacement for the older GRIB-API, which is now deprecated. diff --git a/iris_grib/__init__.py b/iris_grib/__init__.py index de2a5e0f..6b7ca90a 100644 --- a/iris_grib/__init__.py +++ b/iris_grib/__init__.py @@ -5,7 +5,7 @@ """ Conversion of cubes to/from GRIB. -See: `ECMWF GRIB API `_. +See: `ECMWF GRIB API `_. """