From 72ef90ddd896ab43011b66e3b79b8d0134992eac Mon Sep 17 00:00:00 2001 From: Patrick Peglar Date: Thu, 11 Jan 2024 16:30:05 +0000 Subject: [PATCH] v0x19 docs update (#370) * Fix the docs building on readthedocs (#366) * correct yml reference and rename * add fuller readthedocs config * wip * remove comments * Docs updates for the v0.19 release (not done in the original tagged release). * Remove redundant sphinx config causing warnings. * Fix presentation of release-page link. * Add v0.19.1 whatsnew, just to cover the docs update. * Update docs/conf.py Co-authored-by: Elias <110238618+ESadek-MO@users.noreply.github.com> * Update .readthedocs.yml * Update docs/conf.py Co-authored-by: Elias <110238618+ESadek-MO@users.noreply.github.com> --------- Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: Elias <110238618+ESadek-MO@users.noreply.github.com> --- .readthedocs.yml | 18 +++++++++++++ docs/conf.py | 4 +-- docs/index.rst | 2 +- docs/ref/release_notes.rst | 52 +++++++++++++++++++++++++++++++++++--- readthedocs.yml | 2 -- requirements/py311.yml | 4 +++ 6 files changed, 73 insertions(+), 9 deletions(-) create mode 100644 .readthedocs.yml delete mode 100644 readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 000000000..d9e6d5cec --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,18 @@ +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: mambaforge-4.10 + +conda: + environment: requirements/readthedocs.yml + +sphinx: + configuration: docs/conf.py + fail_on_warning: false + +python: + install: + - method: pip + path: . diff --git a/docs/conf.py b/docs/conf.py index db9a165bd..1bea46380 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +# language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -145,7 +145,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/index.rst b/docs/index.rst index d13f95cd3..e98a5abf3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Iris-grib v0.18 +Iris-grib v0.19 =============== The library ``iris-grib`` provides functionality for converting between weather and diff --git a/docs/ref/release_notes.rst b/docs/ref/release_notes.rst index c8d9db83c..f6b4dc552 100644 --- a/docs/ref/release_notes.rst +++ b/docs/ref/release_notes.rst @@ -1,24 +1,43 @@ Release Notes ============= +What's new in iris-grib v0.19.1 +------------------------------- + +:Release: 0.19.1 +:Date: 14 December 2023 + +Documentation +^^^^^^^^^^^^^ +* `@pp-mo `_ updated the release notes with v0.19 changes. + `(PR#370) `_ + What's new in iris-grib v0.19.0 ------------------------------- :Release: 0.19.0 -:Date: [unreleased] +:Date: 16 November 2023 +See also : +`GitHub v0.19.0 release page `_ -======= Features ^^^^^^^^ -* `@lbdreyer `_ and +* `@lbdreyer `_ and `@pp-mo `_ (reviewer) modified the loading of GRIB messages with an unrecognised fixed surface type. These are now loaded in as an unnamed coordinate with an attribute called GRIB_fixed_surface_type. iris-grib will also save out cubes with this attribute as the given fixed - surface type.`(PR#318) `_ + surface type. `(PR#318) `_ +* `@trexfeathers `_ extended Transverse Mercator + to support negative scanning. + `(PR#296) `_ + +* `@trexfeathers `_ added a number of new GRIB-CF + mappings, i.e. translations from GRIB parameters to CF standard names and vice-versa. + `(PR#297) `_ Bugs Fixed ^^^^^^^^^^ @@ -31,11 +50,36 @@ Bugs Fixed in Earth's radius will result in a different coordinate system and may also affect the coordinate values. `(PR#316) `_ +* `@s-boardman `_ corrected the calculation of bounded + forecast periods in GRIB1 loading. + `(PR#322) `_ +* `@david-bentley `_ fixed the calculation of message + file offsets to work in Windows as well as Linux, which was causing load failures. + `(PR#287) `_ +* `@bjlittle `_ fixed an error that occurred when a + message had all-missing data points. + `(PR#362) `_ + +Internal +^^^^^^^^ +* `@lbdreyer `_ relicensed the repo from LGPL-3 to BSD-3. + `(PR#359) `_ Dependencies ^^^^^^^^^^^^ * now requires Python version >= 3.9 +* replaced deprecated eccodes-python PyPI package with new eccodes by @valeriupredoi in #357 +* `@valeriupredoi `_ replaced the deprecated + eccodes-python PyPI package with eccodes. + `(PR#357) `_ + +New Contributors +^^^^^^^^^^^^^^^^ +Welcome to +* `@s-boardman `_ +* `@david-bentley `_ +* `@valeriupredoi `_ What's new in iris-grib v0.18.0 diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 4653044cc..000000000 --- a/readthedocs.yml +++ /dev/null @@ -1,2 +0,0 @@ -conda: - file: requirements/ci/readthedocs.yml diff --git a/requirements/py311.yml b/requirements/py311.yml index 4417eccdc..8df4d4294 100644 --- a/requirements/py311.yml +++ b/requirements/py311.yml @@ -24,3 +24,7 @@ dependencies: - pep8 - requests - nose + +# Documentation dependencies. + - sphinx + - sphinx_rtd_theme \ No newline at end of file