Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into apidoc_improvements
Browse files Browse the repository at this point in the history
* upstream/main:
  Two negating pins for dependencies - libnetcdf and numpy (SciTools#5274)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5275)
  updated installing instructions to use pip (SciTools#5273)
  remove sphinx-panel config as now longer needed (SciTools#5272)
  • Loading branch information
tkknight committed Apr 25, 2023
2 parents b8c1596 + cb287ce commit f0dce12
Show file tree
Hide file tree
Showing 11 changed files with 127 additions and 137 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ repos:
- id: no-commit-to-branch

- repo: https://github.com/codespell-project/codespell
rev: "v2.2.2"
rev: "v2.2.4"
hooks:
- id: codespell
types_or: [asciidoc, python, markdown, rst]
Expand Down
4 changes: 0 additions & 4 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,6 @@ def _dotv(version):
extensions.extend(["sphinxcontrib.apidoc"])
extensions.extend(["api_rst_formatting"])

# -- panels extension ---------------------------------------------------------
# See https://sphinx-panels.readthedocs.io/en/latest/
panels_add_bootstrap_css = False

# -- Napoleon extension -------------------------------------------------------
# See https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html
napoleon_google_docstring = True
Expand Down
6 changes: 3 additions & 3 deletions docs/src/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,10 @@ all the packages from the `testing` and `documentation` sections.

.. _requirements: https://github.com/scitools/iris/tree/main/requirements

Finally you need to run the command to configure your shell environment
to find your local Iris code::
Finally you need to run the command to configure your environment
to find your local Iris code. From your Iris directory run::

python setup.py develop
pip install --no-deps --editable .


Running the Tests
Expand Down
8 changes: 7 additions & 1 deletion docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,10 @@ This document explains the changes made to Iris for this release
3.11. (:pull:`5226`)

#. `@rcomer`_ dropped support for python 3.8, in accordance with the NEP29_
recommendations (:pull:`5226`)
recommendations (:pull:`5226`)

#. `@trexfeathers`_ introduced the ``libnetcdf !=4.9.1`` and ``numpy !=1.24.3``
pins (:pull:`5274`)


📚 Documentation
Expand All @@ -80,6 +83,9 @@ This document explains the changes made to Iris for this release
``livehtml`` to auto generate the documentation when changes are detected
during development. (:pull:`5258`)

#. `@tkknight`_ updated the :ref:`installing_from_source` instructions to use
``pip``. (:pull:`5273`)

#. `@tkknight`_ removed the legacy custom sphinx extensions that generate the
API documentation. Instead use a less complex approach via
`sphinx-apidoc`_. (:pull:`5264`)
Expand Down
76 changes: 36 additions & 40 deletions requirements/locks/py310-linux-64.lock

Large diffs are not rendered by default.

76 changes: 36 additions & 40 deletions requirements/locks/py311-linux-64.lock

Large diffs are not rendered by default.

76 changes: 36 additions & 40 deletions requirements/locks/py39-linux-64.lock

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions requirements/py310.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ dependencies:
- cf-units >=3.1
- cftime >=1.5
- dask-core >=2022.9.0
- libnetcdf <4.9
- libnetcdf !=4.9.1
- matplotlib >=3.5
- netcdf4
- numpy >=1.19
- numpy >=1.21, !=1.24.3
- python-xxhash
- pyproj
- scipy
Expand Down
4 changes: 2 additions & 2 deletions requirements/py311.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ dependencies:
- cf-units >=3.1
- cftime >=1.5
- dask-core >=2022.9.0
- libnetcdf <4.9
- libnetcdf !=4.9.1
- matplotlib >=3.5
- netcdf4
- numpy >=1.19
- numpy >=1.21, !=1.24.3
- python-xxhash
- pyproj
- scipy
Expand Down
4 changes: 2 additions & 2 deletions requirements/py39.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ dependencies:
- cf-units >=3.1
- cftime >=1.5
- dask-core >=2022.9.0
- libnetcdf <4.9
- libnetcdf !=4.9.1
- matplotlib >=3.5
- netcdf4
- numpy >=1.19
- numpy >=1.21, !=1.24.3
- python-xxhash
- pyproj
- scipy
Expand Down
4 changes: 2 additions & 2 deletions requirements/pypi-core.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ cartopy>=0.21
cf-units>=3.1
cftime>=1.5.0
dask[array]>=2022.9.0
# libnetcdf<4.9 (not available on PyPI)
# libnetcdf!=4.9.1 (not available on PyPI)
matplotlib>=3.5
netcdf4
numpy>=1.19
numpy>=1.21,!=1.24.3
pyproj
scipy
shapely!=1.8.3
Expand Down

0 comments on commit f0dce12

Please sign in to comment.