Merge main to fix whatsnew conflict

Author: Will Benfold

.cirrus.yml

@@ -141,8 +141,6 @@ task:
   only_if: ${SKIP_TEST_TASK} == ""
   << : *CREDITS_TEMPLATE
   matrix:
-    env:
-      PY_VER: 3.7
     env:
       PY_VER: 3.8
   name: "${CIRRUS_OS}: py${PY_VER} tests"

.github/workflows/benchmark.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   benchmark:
+    if: "github.repository == 'SciTools/iris'"
     runs-on: ubuntu-latest
 
     env:

.github/workflows/refresh-lockfiles.yml

@@ -28,6 +28,7 @@ on:
 jobs:
 
   no_clobber:
+    if: "github.repository == 'SciTools/iris'"
     runs-on: ubuntu-latest
     steps:
       # check if the auto-update-lockfiles branch exists.  If it does, and someone other than
@@ -64,12 +65,13 @@ jobs:
     # this list below should be changed when covering more python versions
     # TODO: generate this matrix automatically from the list of available py**.yml files
     #       ref: https://tomasvotruba.com/blog/2020/11/16/how-to-make-dynamic-matrix-in-github-actions/
+    if: "github.repository == 'SciTools/iris'"
     runs-on: ubuntu-latest
     needs: no_clobber
 
     strategy:
       matrix:
-        python: ['37', '38']
+        python: ['38']
 
     steps:
       - uses: actions/checkout@v2
@@ -89,6 +91,7 @@ jobs:
   create_pr:
     # once the matrix job has completed all the lock files will have been uploaded as artifacts.
     # Download the artifacts, add them to the repo, and create a PR.
+    if: "github.repository == 'SciTools/iris'"
     runs-on: ubuntu-latest
     needs: gen_lockfiles
 

.github/workflows/stale.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
   stale:
+    if: "github.repository == 'SciTools/iris'"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ minimum_pre_commit_version: 1.21.0
 
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.1.0
     hooks:
         # Prevent giant files from being committed.
     -   id: check-added-large-files
@@ -29,7 +29,7 @@ repos:
     -   id: no-commit-to-branch
 
 -   repo: https://github.com/psf/black
-    rev: 21.10b0
+    rev: 21.12b0
     hooks:
     -   id: black
         pass_filenames: false
@@ -50,7 +50,7 @@ repos:
         args: [--filter-files]
 
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v1.11.0
+    rev: v1.12.0
     hooks:
     -   id: blacken-docs
         types: [file, rst]

.readthedocs.yml

@@ -1,20 +1,20 @@
 version: 2
 
 build:
-    image: latest
+  os: ubuntu-20.04
+  tools:
+    python: mambaforge-4.10
 
 conda:
-    environment: requirements/ci/readthedocs.yml
+  environment: requirements/ci/readthedocs.yml
 
 sphinx:
-    configuration: docs/src/conf.py
-    fail_on_warning: false
+  configuration: docs/src/conf.py
+  fail_on_warning: false
 
 python:
-    install: 
-        - method: setuptools
-          path: .
-
-formats:
-    - htmlzip
-    - pdf
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

docs/gallery_code/README.rst

@@ -23,4 +23,4 @@ you may start the jupyter notebook via::
 
 If you wish to contribute to the gallery see the 
 :ref:`contributing.documentation.gallery` section of the 
-:ref:`contributing.documentation`.
+:ref:`contributing.documentation_full`.

docs/src/_templates/imagehash.html

@@ -0,0 +1,15 @@
+{% extends "!layout.html" %}
+
+{% block body %}
+
+<h1>Test: {{ test }}</h1>
+
+
+{% for hash, file in hashfiles %}
+<div>
+    <h3>{{hash}}</h3>
+    <img src="{{file}}" />
+</div>
+{% endfor %}
+
+{% endblock %}

docs/src/conf.py

@@ -158,6 +158,7 @@ def _dotv(version):
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.mathmpl",
     "matplotlib.sphinxext.plot_directive",
+    "image_test_output",
 ]
 
 if skip_api == "1":
@@ -208,6 +209,7 @@ def _dotv(version):
 # api generation configuration
 autodoc_member_order = "groupwise"
 autodoc_default_flags = ["show-inheritance"]
+autodoc_typehints = "none"
 autosummary_generate = True
 autosummary_imported_members = True
 autopackage_name = ["iris"]

docs/src/developers_guide/contributing_code_formatting.rst

@@ -57,5 +57,13 @@ will look similar to::
 .. note:: You can also run `black`_ and `flake8`_ manually.  Please see the
           their officially documentation for more information.
 
+Type Hinting
+------------
+Iris is gradually adding
+`type hints <https://docs.python.org/3/library/typing.html>`_ into the
+codebase. The reviewer will look for type hints in a pull request; if you're
+not confident with these, feel free to work together with the reviewer to
+add/improve them.
+
 
 .. _pre-commit: https://pre-commit.com/