Skip to content

Commit 995932d

Browse files
trexfeatherstrexfeathers
authored
Adopt Diataxis (#6868)
* Introduce user_manual. * Reader-level restructure. * Add sphinx-needs to dependencies. * Add licence header to user_manual_directives.py. * Address Sphinx warnings. * Populate the explanation and how-to directories. * Populate the reference and tutorial directories. * Fix some references I missed before. * Refactor of get_started. * Remove defunct IEP directory. * Itemise all of Iris public API. * Rendering improvements. * Itemise all of the Iris docs pages. * Itemise all of the Gallery pages. * Topic descriptions. * user_manual_directives.py code quality. * Needs item validation routine. * Remove column titles. * Fix doctests. * Implement redirects. * Update lock files. * Better use of inbuilt indenting. * Remove Get Started and Iris API from top level toctree. * Clearer wording about the purpose of the User Manual and User Guide. * Page summary improvements. * Topic tag improvements. * Fix admonition. * Update lock files. * More accurate caption for plot_atlantic_profiles. * Diataxis metadata for s3_io.rst. * Review actions. * Rename topic_statistics. * Less aggressive phrasing about how to navigate. * Update lock files. * Adapt to sphinx-needs v7. * What's New entry.
1 parent 7da9f80 commit 995932d

File tree

199 files changed

+1707
-585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+1707
-585
lines changed

‎.lycheeignore‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,17 @@ file:///
44
# DEAD : legacy in various old whatsnews
55
https://biggus.readthedocs.io
66

7-
# unkown problem, works in browser : used in further_topics/ugrid/data_model
7+
# unknown problem, works in browser : used in
8+
# docs/src/user_manual/explanation/mesh_data_model.rst
89
https://doi.org/10.3390/jmse2010194
910

10-
# DEAD, todo:remove, used in docs/src/userguide/plotting_a_cube.rst
11+
# DEAD, todo:remove, used in docs/src/user_manual/tutorial/plotting_a_cube.rst
1112
https://effbot.org
1213

1314
# nonfunctional, found in some code examples
1415
https://foo/
1516

16-
# DEAD, todo:remove, used in docs/src/further_topics/ugrid/data_model.rst
17+
# DEAD, todo:remove, used in docs/src/user_manual/explanation/mesh_data_model.rst
1718
https://ibm-design-language.eu-de.mybluemix.net/design/language/resources/color-library
1819

1920
# DEAD, legacy in whatsnew/1.4.rst
@@ -45,14 +46,14 @@ https://stickler-ci.com
4546
# DEAD, todo:remove, used in lib/iris/symbols.py
4647
https://www.wmo.int/pages/prog/www/DPFS/documents/485_Vol_I_en_colour.pdf
4748

48-
# DEAD, todo:remove, used in docs/src/userguide/plotting_a_cube.rst
49+
# DEAD, todo:remove, used in docs/src/user_manual/tutorial/plotting_a_cube.rst
4950
# unkown problem, works in browser : used in docs/src/index.rst
5051
https://www.flaticon.com
5152

5253
# nonfunctional example, used in lib/iris/io/__init__.py
5354
https://www.thing.com
5455

55-
# DEAD, todo:remove, used in docs/src/userguide/plotting_a_cube.rst
56+
# DEAD, todo:remove, used in docs/src/user_manual/tutorial/plotting_a_cube.rst
5657
https://www.personal.psu.edu/cab38/ColorBrewer/ColorBrewer_updates.html
5758

5859
# nonfunctional, found in some code examples

‎docs/gallery_code/general/plot_SOI_filtering.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Applying a Filter to a Time-Series
33
==================================
44
5+
.. how-to:: Applying a Filter to a Time-Series
6+
:tags: topic_plotting;topic_maths_stats
7+
8+
How to apply a low pass filter to an Iris Cube via rolling_window().
9+
510
This example demonstrates low pass filtering a time-series by applying a
611
weighted running mean over the time dimension.
712

‎docs/gallery_code/general/plot_anomaly_log_colouring.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Colouring Anomaly Data With Logarithmic Scaling
33
===============================================
44
5+
.. how-to:: Colouring Anomaly Data With Logarithmic Scaling
6+
:tags: topic_plotting;topic_maths_stats
7+
8+
How to visualise values using a logarithmic scale.
9+
510
In this example, we need to plot anomaly data where the values have a
611
"logarithmic" significance -- i.e. we want to give approximately equal ranges
712
of colour between data values of, say, 1 and 10 as between 10 and 100.

‎docs/gallery_code/general/plot_coriolis.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Deriving the Coriolis Frequency Over the Globe
33
==============================================
44
5+
.. how-to:: Deriving the Coriolis Frequency Over the Globe
6+
:tags: topic_plotting;topic_data_model
7+
8+
How to create your own Cube from computed data and visualise it.
9+
510
This code computes the Coriolis frequency and stores it in a cube with
611
associated metadata. It then plots the Coriolis frequency on an orthographic
712
projection.

‎docs/gallery_code/general/plot_cross_section.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Cross Section Plots
33
===================
44
5+
.. how-to:: Cross Section Plots
6+
:tags: topic_plotting;topic_slice_combine
7+
8+
How to visualise cross-sections of multi-dimensional Cubes.
9+
510
This example demonstrates contour plots of a cross-sectioned multi-dimensional
611
cube which features a hybrid height vertical coordinate system.
712

‎docs/gallery_code/general/plot_custom_aggregation.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Calculating a Custom Statistic
33
==============================
44
5+
.. how-to:: Calculating a Custom Statistic
6+
:tags: topic_plotting;topic_maths_stats
7+
8+
How to define and use a custom aggregation operation, including visualisation.
9+
510
This example shows how to define and use a custom
611
:class:`iris.analysis.Aggregator`, that provides a new statistical operator for
712
use with cube aggregation functions such as :meth:`~iris.cube.Cube.collapsed`,

‎docs/gallery_code/general/plot_custom_file_loading.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Loading a Cube From a Custom File Format
33
========================================
44
5+
.. how-to:: Loading a Cube From a Custom File Format
6+
:tags: topic_plotting;topic_load_save
7+
8+
How to visualise data from a file Iris does not natively support.
9+
510
This example shows how a custom text file can be loaded using the standard Iris
611
load mechanism.
712

‎docs/gallery_code/general/plot_global_map.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Quickplot of a 2D Cube on a Map
33
===============================
44
5+
.. how-to:: Quickplot of a 2D Cube on a Map
6+
:tags: topic_plotting
7+
8+
A demonstration of basic iris.quickplot use.
9+
510
This example demonstrates a contour plot of global air temperature. The plot
611
title and the labels for the axes are automatically derived from the metadata.
712

‎docs/gallery_code/general/plot_inset.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Test Data Showing Inset Plots
33
=============================
44
5+
.. how-to:: Test Data Showing Inset Plots
6+
:tags: topic_plotting;topic_maths_stats
7+
8+
How to create inset plots within a main plot.
9+
510
This example demonstrates the use of a single 3D data cube with time, latitude
611
and longitude dimensions to plot a temperature series for a single latitude
712
coordinate, with an inset plot of the data region.

‎docs/gallery_code/general/plot_lineplot_with_legend.py‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
Multi-Line Temperature Profile Plot
33
===================================
44
5+
.. how-to:: Multi-Line Temperature Profile Plot
6+
:tags: topic_plotting
7+
8+
How to plot multiple lines on a single plot with a legend.
9+
510
""" # noqa: D205, D212, D400
611

712
import matplotlib.pyplot as plt

0 commit comments

Comments
 (0)