Merge branch 'master' into iep_creation

* master: remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958)
tkknight · Feb 1, 2021 · 921f60d · 921f60d
2 parents 7539f0c + 636b97b
commit 921f60d
Show file tree

Hide file tree

Showing 109 changed files with 7,221 additions and 834 deletions.
diff --git a/docs/iris/gallery_code/general/plot_SOI_filtering.py b/docs/iris/gallery_code/general/plot_SOI_filtering.py
@@ -1,5 +1,5 @@
 """
-Applying a filter to a time-series
+Applying a Filter to a Time-Series
 ==================================
 
 This example demonstrates low pass filtering a time-series by applying a

diff --git a/docs/iris/gallery_code/general/plot_anomaly_log_colouring.py b/docs/iris/gallery_code/general/plot_anomaly_log_colouring.py
@@ -1,5 +1,5 @@
 """
-Colouring anomaly data with logarithmic scaling
+Colouring Anomaly Data With Logarithmic Scaling
 ===============================================
 
 In this example, we need to plot anomaly data where the values have a

diff --git a/docs/iris/gallery_code/general/plot_coriolis.py b/docs/iris/gallery_code/general/plot_coriolis.py
@@ -1,5 +1,5 @@
 """
-Deriving the Coriolis frequency over the globe
+Deriving the Coriolis Frequency Over the Globe
 ==============================================
 
 This code computes the Coriolis frequency and stores it in a cube with

diff --git a/docs/iris/gallery_code/general/plot_cross_section.py b/docs/iris/gallery_code/general/plot_cross_section.py
@@ -1,5 +1,5 @@
 """
-Cross section plots
+Cross Section Plots
 ===================
 
 This example demonstrates contour plots of a cross-sectioned multi-dimensional

diff --git a/docs/iris/gallery_code/general/plot_custom_aggregation.py b/docs/iris/gallery_code/general/plot_custom_aggregation.py
@@ -1,5 +1,5 @@
 """
-Calculating a custom statistic
+Calculating a Custom Statistic
 ==============================
 
 This example shows how to define and use a custom

diff --git a/docs/iris/gallery_code/general/plot_custom_file_loading.py b/docs/iris/gallery_code/general/plot_custom_file_loading.py
@@ -1,5 +1,5 @@
 """
-Loading a cube from a custom file format
+Loading a Cube From a Custom File Format
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This example shows how a custom text file can be loaded using the standard Iris

diff --git a/docs/iris/gallery_code/general/plot_global_map.py b/docs/iris/gallery_code/general/plot_global_map.py
@@ -1,5 +1,5 @@
 """
-Quickplot of a 2d cube on a map
+Quickplot of a 2D Cube on a Map
 ===============================
 
 This example demonstrates a contour plot of global air temperature. The plot

diff --git a/docs/iris/gallery_code/general/plot_lineplot_with_legend.py b/docs/iris/gallery_code/general/plot_lineplot_with_legend.py
@@ -1,5 +1,5 @@
 """
-Multi-line temperature profile plot
+Multi-Line Temperature Profile Plot
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 """

diff --git a/docs/iris/gallery_code/general/plot_polar_stereo.py b/docs/iris/gallery_code/general/plot_polar_stereo.py
@@ -1,5 +1,5 @@
 """
-Example of a polar stereographic plot
+Example of a Polar Stereographic Plot
 =====================================
 
 Demonstrates plotting data that are defined on a polar stereographic

diff --git a/docs/iris/gallery_code/general/plot_polynomial_fit.py b/docs/iris/gallery_code/general/plot_polynomial_fit.py
@@ -1,5 +1,5 @@
 """
-Fitting a polynomial
+Fitting a Polynomial
 ====================
 
 This example demonstrates computing a polynomial fit to 1D data from an Iris

diff --git a/docs/iris/gallery_code/general/plot_projections_and_annotations.py b/docs/iris/gallery_code/general/plot_projections_and_annotations.py
@@ -1,5 +1,5 @@
 """
-Plotting in different projections
+Plotting in Different Projections
 =================================
 
 This example shows how to overlay data and graphics in different projections,

diff --git a/docs/iris/gallery_code/general/plot_rotated_pole_mapping.py b/docs/iris/gallery_code/general/plot_rotated_pole_mapping.py
@@ -1,5 +1,5 @@
 """
-Rotated pole mapping
+Rotated Pole Mapping
 =====================
 
 This example uses several visualisation methods to achieve an array of

diff --git a/docs/iris/gallery_code/meteorology/plot_COP_1d.py b/docs/iris/gallery_code/meteorology/plot_COP_1d.py
@@ -1,5 +1,5 @@
 """
-Global average annual temperature plot
+Global Average Annual Temperature Plot
 ======================================
 
 Produces a time-series plot of North American temperature forecasts for 2

diff --git a/docs/iris/gallery_code/meteorology/plot_COP_maps.py b/docs/iris/gallery_code/meteorology/plot_COP_maps.py
@@ -1,5 +1,5 @@
 """
-Global average annual temperature maps
+Global Average Annual Temperature Maps
 ======================================
 
 Produces maps of global temperature forecasts from the A1B and E1 scenarios.

diff --git a/docs/iris/gallery_code/meteorology/plot_TEC.py b/docs/iris/gallery_code/meteorology/plot_TEC.py
@@ -1,5 +1,5 @@
 """
-Ionosphere space weather
+Ionosphere Space Weather
 ========================
 
 This space weather example plots a filled contour of rotated pole point

diff --git a/docs/iris/gallery_code/meteorology/plot_hovmoller.py b/docs/iris/gallery_code/meteorology/plot_hovmoller.py
@@ -1,5 +1,5 @@
 """
-Hovmoller diagram of monthly surface temperature
+Hovmoller Diagram of Monthly Surface Temperature
 ================================================
 
 This example demonstrates the creation of a Hovmoller diagram with fine control

diff --git a/docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py b/docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py
@@ -1,5 +1,5 @@
 """
-Seasonal ensemble model plots
+Seasonal Ensemble Model Plots
 =============================
 
 This example demonstrates the loading of a lagged ensemble dataset from the

diff --git a/docs/iris/gallery_code/meteorology/plot_wind_speed.py b/docs/iris/gallery_code/meteorology/plot_wind_speed.py
@@ -1,6 +1,6 @@
 """
-Plotting wind direction using quiver
-===========================================================
+Plotting Wind Direction Using Quiver
+====================================
 
 This example demonstrates using quiver to plot wind speed contours and wind
 direction arrows from wind vector component input data. The vector components

diff --git a/docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py b/docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py
@@ -1,5 +1,5 @@
 """
-Oceanographic profiles and T-S diagrams
+Oceanographic Profiles and T-S Diagrams
 =======================================
 
 This example demonstrates how to plot vertical profiles of different

diff --git a/docs/iris/gallery_code/oceanography/plot_load_nemo.py b/docs/iris/gallery_code/oceanography/plot_load_nemo.py
@@ -1,5 +1,5 @@
 """
-Load a time series of data from the NEMO model
+Load a Time Series of Data From the NEMO Model
 ==============================================
 
 This example demonstrates how to load multiple files containing data output by

diff --git a/docs/iris/src/common_links.inc b/docs/iris/src/common_links.inc
@@ -1,28 +1,57 @@
-.. _SciTools: https://github.com/SciTools
+.. comment
+    Common resources in alphabetical order:
+
+.. _.cirrus.yml: https://github.com/SciTools/iris/blob/master/.cirrus.yml
+.. _.flake8.yml: https://github.com/SciTools/iris/blob/master/.flake8
+.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
+.. _conda: https://docs.conda.io/en/latest/
+.. _contributor: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
+.. _core developers: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
+.. _generating sss keys for GitHub: https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
+.. _GitHub Help Documentation: https://docs.github.com/en/github
 .. _Iris: https://github.com/SciTools/iris
 .. _Iris GitHub: https://github.com/SciTools/iris
 .. _iris mailing list: https://groups.google.com/forum/#!forum/scitools-iris
+.. _iris-sample-data: https://github.com/SciTools/iris-sample-data
+.. _iris-test-data: https://github.com/SciTools/iris-test-data
 .. _issue: https://github.com/SciTools/iris/issues
 .. _issues: https://github.com/SciTools/iris/issues
+.. _legacy documentation: https://scitools.org.uk/iris/docs/v2.4.0/
+.. _matplotlib: https://matplotlib.org/
+.. _napolean: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html
+.. _New Issue: https://github.com/scitools/iris/issues/new/choose
 .. _pull request: https://github.com/SciTools/iris/pulls
 .. _pull requests: https://github.com/SciTools/iris/pulls
-.. _contributor: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
-.. _core developers: https://github.com/SciTools/scitools.org.uk/blob/master/contributors.json
-.. _iris-test-data: https://github.com/SciTools/iris-test-data
-.. _iris-sample-data: https://github.com/SciTools/iris-sample-data
-.. _test-iris-imagehash: https://github.com/SciTools/test-iris-imagehash
 .. _readthedocs.yml: https://github.com/SciTools/iris/blob/master/requirements/ci/readthedocs.yml
-.. _travis-ci: https://travis-ci.org/github/SciTools/iris
-.. _.travis.yml: https://github.com/SciTools/iris/blob/master/.travis.yml
-.. _.stickler.yml: https://github.com/SciTools/iris/blob/master/.stickler.yml
-.. _.flake8.yml: https://github.com/SciTools/iris/blob/master/.flake8
-.. _GitHub Help Documentation: https://docs.github.com/en/github
-.. _using git: https://docs.github.com/en/github/using-git
-.. _generating sss keys for GitHub: https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account
-.. _New Issue: https://github.com/scitools/iris/issues/new/choose
-.. _matplotlib: https://matplotlib.org/
-.. _conda: https://docs.conda.io/en/latest/
+.. _SciTools: https://github.com/SciTools
 .. _sphinx: https://www.sphinx-doc.org/en/master/
-.. _napolean: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html
-.. _legacy documentation: https://scitools.org.uk/iris/docs/v2.4.0/
-.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
+.. _test-iris-imagehash: https://github.com/SciTools/test-iris-imagehash
+.. _using git: https://docs.github.com/en/github/using-git
+
+
+.. comment
+    Core developers (@github names) in alphabetical order:
+
+.. _@abooton: https://github.com/abooton
+.. _@alastair-gemmell: https://github.com/alastair-gemmell
+.. _@ajdawson: https://github.com/ajdawson
+.. _@bjlittle: https://github.com/bjlittle
+.. _@bouweandela: https://github.com/bouweandela
+.. _@corinnebosley: https://github.com/corinnebosley
+.. _@cpelley: https://github.com/cpelley
+.. _@djkirkham: https://github.com/djkirkham
+.. _@DPeterK: https://github.com/DPeterK
+.. _@esc24: https://github.com/esc24
+.. _@jonseddon: https://github.com/jonseddon
+.. _@jvegasbsc: https://github.com/jvegasbsc
+.. _@lbdreyer: https://github.com/lbdreyer
+.. _@marqh: https://github.com/marqh
+.. _@pelson: https://github.com/pelson
+.. _@pp-mo: https://github.com/pp-mo
+.. _@QuLogic: https://github.com/QuLogic
+.. _@rcomer: https://github.com/rcomer
+.. _@rhattersley: https://github.com/rhattersley
+.. _@stephenworsley: https://github.com/stephenworsley
+.. _@tkknight: https://github.com/tkknight
+.. _@trexfeathers: https://github.com/trexfeathers
+.. _@zklaus: https://github.com/zklaus
diff --git a/docs/iris/src/conf.py b/docs/iris/src/conf.py
@@ -82,8 +82,8 @@ def autolog(message):
 if iris.__version__ == "dev":
     version = "dev"
 else:
-    # major.feature(.minor)-dev -> major.minor
-    version = ".".join(iris.__version__.split("-")[0].split(".")[:2])
+    # major.minor.patch-dev -> major.minor.patch
+    version = ".".join(iris.__version__.split("-")[0].split(".")[:3])
 # The full version, including alpha/beta/rc tags.
 release = iris.__version__
 
@@ -232,7 +232,7 @@ def autolog(message):
     "menu_links_name": "Support",
     "menu_links": [
         (
-            '<i class="fa fa-github fa-fw"></i> Source code',
+            '<i class="fa fa-github fa-fw"></i> Source Code',
             "https://github.com/SciTools/iris",
         ),
         (
@@ -244,11 +244,11 @@ def autolog(message):
             "https://groups.google.com/forum/#!forum/scitools-iris-dev",
         ),
         (
-            '<i class="fa fa-question fa-fw"></i> StackOverflow for "How do I?"',
+            '<i class="fa fa-question fa-fw"></i> StackOverflow for "How Do I?"',
             "https://stackoverflow.com/questions/tagged/python-iris",
         ),
         (
-            '<i class="fa fa-book fa-fw"></i> Legacy documentation',
+            '<i class="fa fa-book fa-fw"></i> Legacy Documentation',
             "https://scitools.org.uk/iris/docs/v2.4.0/index.html",
         ),
     ],
@@ -271,6 +271,8 @@ def autolog(message):
     "http://schacon.github.com/git",
     "http://scitools.github.com/cartopy",
     "http://www.wmo.int/pages/prog/www/DPFS/documents/485_Vol_I_en_colour.pdf",
+    "https://software.ac.uk/how-cite-software",
+    "http://www.esrl.noaa.gov/psd/data/gridded/conventions/cdc_netcdf_standard.shtml",
 ]
 
 # list of sources to exclude from the build.

diff --git a/docs/iris/src/copyright.rst b/docs/iris/src/copyright.rst
@@ -1,8 +1,8 @@
 
-Iris copyright, licensing and contributors
+Iris Copyright, Licensing and Contributors
 ==========================================
 
-Iris code
+Iris Code
 ---------
 
 All Iris source code, unless explicitly stated, is ``Copyright Iris
@@ -20,7 +20,7 @@ You should find all source files with the following header:
     licensing details.
 
 
-Iris documentation and examples
+Iris Documentation and Examples
 -------------------------------
 
 All documentation, examples and sample data found on this website and in source repository 

diff --git a/docs/iris/src/developers_guide/ci_checks.png b/docs/iris/src/developers_guide/ci_checks.png
diff --git a/docs/iris/src/developers_guide/contributing_changes.rst b/docs/iris/src/developers_guide/contributing_changes.rst
@@ -1,7 +1,7 @@
 
 .. _contributing.changes:
 
-Contributing your changes
+Contributing Your Changes
 =========================
 
 .. toctree::

diff --git a/docs/iris/src/developers_guide/contributing_ci_tests.rst b/docs/iris/src/developers_guide/contributing_ci_tests.rst
@@ -10,8 +10,7 @@ automatically when a pull request is created, updated or merged against
 Iris **master**.  The checks performed are:
 
 * :ref:`testing_cla`
-* :ref:`testing_travis`
-* :ref:`testing_stickler`
+* :ref:`testing_cirrus`
 
 
 .. _testing_cla:
@@ -24,33 +23,23 @@ A bot that checks the user who created the pull request has signed the
 please see https://scitools.org.uk/organisation.html#governance
 
 
-.. _testing_stickler:
+.. _testing_cirrus:
 
-Stickler CI
-***********
-
-Automatically enforces coding standards.  The configuration file named
-`.stickler.yml`_ is in the Iris_ root directory.  For more information see
-https://stickler-ci.com/.
-
-
-.. _testing_travis:
-
-Travis-CI
+Cirrus-CI
 *********
 
 The unit and integration tests in Iris are an essential mechanism to ensure
 that the Iris code base is working as expected.  :ref:`developer_running_tests`
 may be run manually but to ensure the checks are performed a
-continuous integration testing tool named `travis-ci`_ is used.
+continuous integration testing tool named `cirrus-ci`_ is used.
 
-A `travis-ci`_ configuration file named `.travis.yml`_
-is in the Iris repository which tells travis-ci what commands to run.  The
+A `cirrus-ci`_ configuration file named `.cirrus.yml`_
+is in the Iris repository which tells Cirrus-CI what commands to run.  The
 commands include retrieving the Iris code base and associated test files using
-conda and then running the tests.  `travis-ci`_ allows for a matrix of tests to
+conda and then running the tests.  `cirrus-ci`_ allows for a matrix of tests to
 be performed to ensure that all expected variations test successfully.
 
-The `travis-ci`_ tests are run automatically against the `Iris`_ master
+The `cirrus-ci`_ tests are run automatically against the `Iris`_ master
 repository when a pull request is submitted, updated or merged.
 
 GitHub Checklist

diff --git a/docs/iris/src/developers_guide/contributing_code_formatting.rst b/docs/iris/src/developers_guide/contributing_code_formatting.rst
@@ -2,7 +2,7 @@
 
 .. _code_formatting:
 
-Code formatting
+Code Formatting
 ===============
 
 To ensure a consistent code format throughout Iris, we recommend using

diff --git a/docs/iris/src/developers_guide/contributing_codebase_index.rst b/docs/iris/src/developers_guide/contributing_codebase_index.rst
@@ -1,6 +1,6 @@
 .. _contributing.documentation.codebase:
 
-Contributing to the code base
+Contributing to the Code Base
 =============================
 
 .. toctree::