From 340a97f150ee4b827ae6fc9bc314bdbb9ee24068 Mon Sep 17 00:00:00 2001 From: Elias Sadek Date: Fri, 24 Nov 2023 11:48:16 +0000 Subject: [PATCH 1/5] moved technical papers to further topics --- docs/src/developers_guide/contributing_getting_involved.rst | 2 +- docs/src/{ => further_topics}/techpapers/index.rst | 0 .../{ => further_topics}/techpapers/missing_data_handling.rst | 0 docs/src/{ => further_topics}/techpapers/netcdf_io.rst | 0 docs/src/{ => further_topics}/techpapers/um_files_loading.rst | 0 docs/src/userguide/index.rst | 1 + 6 files changed, 2 insertions(+), 1 deletion(-) rename docs/src/{ => further_topics}/techpapers/index.rst (100%) rename docs/src/{ => further_topics}/techpapers/missing_data_handling.rst (100%) rename docs/src/{ => further_topics}/techpapers/netcdf_io.rst (100%) rename docs/src/{ => further_topics}/techpapers/um_files_loading.rst (100%) diff --git a/docs/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst index 9ec6559114..f46c324994 100644 --- a/docs/src/developers_guide/contributing_getting_involved.rst +++ b/docs/src/developers_guide/contributing_getting_involved.rst @@ -61,6 +61,6 @@ If you are new to using GitHub we recommend reading the ../generated/api/iris ../whatsnew/index - ../techpapers/index + ../../further_topics/techpapers/index ../copyright ../voted_issues diff --git a/docs/src/techpapers/index.rst b/docs/src/further_topics/techpapers/index.rst similarity index 100% rename from docs/src/techpapers/index.rst rename to docs/src/further_topics/techpapers/index.rst diff --git a/docs/src/techpapers/missing_data_handling.rst b/docs/src/further_topics/techpapers/missing_data_handling.rst similarity index 100% rename from docs/src/techpapers/missing_data_handling.rst rename to docs/src/further_topics/techpapers/missing_data_handling.rst diff --git a/docs/src/techpapers/netcdf_io.rst b/docs/src/further_topics/techpapers/netcdf_io.rst similarity index 100% rename from docs/src/techpapers/netcdf_io.rst rename to docs/src/further_topics/techpapers/netcdf_io.rst diff --git a/docs/src/techpapers/um_files_loading.rst b/docs/src/further_topics/techpapers/um_files_loading.rst similarity index 100% rename from docs/src/techpapers/um_files_loading.rst rename to docs/src/further_topics/techpapers/um_files_loading.rst diff --git a/docs/src/userguide/index.rst b/docs/src/userguide/index.rst index c87323da8e..985532f1c2 100644 --- a/docs/src/userguide/index.rst +++ b/docs/src/userguide/index.rst @@ -48,3 +48,4 @@ they may serve as a useful reference for future exploration. ../further_topics/lenient_maths ../further_topics/dask_best_practices/index ../further_topics/ugrid/index + ../further_topics/techpapers/index From c74bdf250b28878052dee10dbb6870d791d7b773 Mon Sep 17 00:00:00 2001 From: Elias Sadek Date: Fri, 24 Nov 2023 12:02:57 +0000 Subject: [PATCH 2/5] updated old whatsnew --- docs/src/whatsnew/1.7.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/whatsnew/1.7.rst b/docs/src/whatsnew/1.7.rst index 1d7c7c3f60..79d82c8bab 100644 --- a/docs/src/whatsnew/1.7.rst +++ b/docs/src/whatsnew/1.7.rst @@ -329,6 +329,6 @@ Documentation * A clarification of the behaviour of :func:`iris.analysis.calculus.differentiate`. -* A new :doc:`"Technical Papers" ` section has been added to +* A new :ref:`techpapers_index` section has been added to the documentation along with the addition of a paper providing an - :doc:`overview of the load process for UM-like fileformats (e.g. PP and Fieldsfile) `. + :ref:`overview of the load process for UM-like fileformats (e.g. PP and Fieldsfile) `. From 0d84914e464ce513cdd9286185100720e4743870 Mon Sep 17 00:00:00 2001 From: Elias Sadek Date: Fri, 24 Nov 2023 13:30:56 +0000 Subject: [PATCH 3/5] removed line 64 --- docs/src/developers_guide/contributing_getting_involved.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst index f46c324994..6ade098b6b 100644 --- a/docs/src/developers_guide/contributing_getting_involved.rst +++ b/docs/src/developers_guide/contributing_getting_involved.rst @@ -61,6 +61,5 @@ If you are new to using GitHub we recommend reading the ../generated/api/iris ../whatsnew/index - ../../further_topics/techpapers/index ../copyright ../voted_issues From cece9ca43582bf51d8b35d09fdbed0b21ad01c44 Mon Sep 17 00:00:00 2001 From: Elias Sadek Date: Fri, 24 Nov 2023 14:08:34 +0000 Subject: [PATCH 4/5] Technical Paper POC --- docs/src/further_topics/index.rst | 20 +++++++++++++++++++ .../missing_data_handling.rst | 0 .../{techpapers => }/netcdf_io.rst | 0 docs/src/further_topics/techpapers/index.rst | 14 ------------- .../{techpapers => }/um_files_loading.rst | 4 ++-- docs/src/index.rst | 8 ++++++++ docs/src/userguide/index.rst | 14 +------------ docs/src/whatsnew/1.7.rst | 4 ++-- 8 files changed, 33 insertions(+), 31 deletions(-) create mode 100644 docs/src/further_topics/index.rst rename docs/src/further_topics/{techpapers => }/missing_data_handling.rst (100%) rename docs/src/further_topics/{techpapers => }/netcdf_io.rst (100%) delete mode 100644 docs/src/further_topics/techpapers/index.rst rename docs/src/further_topics/{techpapers => }/um_files_loading.rst (100%) diff --git a/docs/src/further_topics/index.rst b/docs/src/further_topics/index.rst new file mode 100644 index 0000000000..90dbfb2ced --- /dev/null +++ b/docs/src/further_topics/index.rst @@ -0,0 +1,20 @@ +.. _further_topics_index: + + +Further Topics +=============== + +Extra information on specific technical issues. + +.. toctree:: + :maxdepth: 1 + + filtering_warnings + metadata + lenient_metadata + lenient_maths + um_files_loading + missing_data_handling + netcdf_io + dask_best_practices/index + ugrid/index diff --git a/docs/src/further_topics/techpapers/missing_data_handling.rst b/docs/src/further_topics/missing_data_handling.rst similarity index 100% rename from docs/src/further_topics/techpapers/missing_data_handling.rst rename to docs/src/further_topics/missing_data_handling.rst diff --git a/docs/src/further_topics/techpapers/netcdf_io.rst b/docs/src/further_topics/netcdf_io.rst similarity index 100% rename from docs/src/further_topics/techpapers/netcdf_io.rst rename to docs/src/further_topics/netcdf_io.rst diff --git a/docs/src/further_topics/techpapers/index.rst b/docs/src/further_topics/techpapers/index.rst deleted file mode 100644 index e97a87f39c..0000000000 --- a/docs/src/further_topics/techpapers/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _techpapers_index: - - -Iris Technical Papers -===================== - -Extra information on specific technical issues. - -.. toctree:: - :maxdepth: 1 - - um_files_loading.rst - missing_data_handling.rst - netcdf_io.rst diff --git a/docs/src/further_topics/techpapers/um_files_loading.rst b/docs/src/further_topics/um_files_loading.rst similarity index 100% rename from docs/src/further_topics/techpapers/um_files_loading.rst rename to docs/src/further_topics/um_files_loading.rst index f94898b3aa..9d9393f16d 100644 --- a/docs/src/further_topics/techpapers/um_files_loading.rst +++ b/docs/src/further_topics/um_files_loading.rst @@ -1,5 +1,3 @@ -.. _um_files_loading: - .. testsetup:: import numpy as np @@ -13,6 +11,8 @@ np.set_printoptions(precision=8) +.. _um_files_loading: + =================================== Iris Handling of PP and Fieldsfiles =================================== diff --git a/docs/src/index.rst b/docs/src/index.rst index b353406f58..ab6730f684 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -203,4 +203,12 @@ The legacy support resources: Iris API +.. toctree:: + :caption: Further Topics + :maxdepth: 1 + :hidden: + + Further Topics + + .. todolist:: diff --git a/docs/src/userguide/index.rst b/docs/src/userguide/index.rst index 985532f1c2..20d4ec3cd1 100644 --- a/docs/src/userguide/index.rst +++ b/docs/src/userguide/index.rst @@ -20,7 +20,7 @@ they may serve as a useful reference for future exploration. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 iris_cubes loading_iris_cubes @@ -37,15 +37,3 @@ they may serve as a useful reference for future exploration. code_maintenance glossary - -.. toctree:: - :maxdepth: 2 - :caption: Further Topics - - ../further_topics/filtering_warnings - ../further_topics/metadata - ../further_topics/lenient_metadata - ../further_topics/lenient_maths - ../further_topics/dask_best_practices/index - ../further_topics/ugrid/index - ../further_topics/techpapers/index diff --git a/docs/src/whatsnew/1.7.rst b/docs/src/whatsnew/1.7.rst index 79d82c8bab..4c3f3197dc 100644 --- a/docs/src/whatsnew/1.7.rst +++ b/docs/src/whatsnew/1.7.rst @@ -329,6 +329,6 @@ Documentation * A clarification of the behaviour of :func:`iris.analysis.calculus.differentiate`. -* A new :ref:`techpapers_index` section has been added to +* A new Technical Papers section has been added to the documentation along with the addition of a paper providing an - :ref:`overview of the load process for UM-like fileformats (e.g. PP and Fieldsfile) `. + :ref:`overview of the load process for UM-like fileformats (e.g. PP and Fieldsfile) `. From 93f455758c2d339c67edccb8a8dd4d8829212be0 Mon Sep 17 00:00:00 2001 From: Elias Sadek Date: Fri, 24 Nov 2023 15:16:15 +0000 Subject: [PATCH 5/5] added a whatsnew --- docs/src/whatsnew/latest.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 3f2f9a1fd9..4423924188 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -126,6 +126,9 @@ This document explains the changes made to Iris for this release saving and loading, :ref:`netcdf_io` with a section on chunking, and placeholders for further topics. (:pull:`5588`) +#. `@Esadek-MO`_ moved :ref:`further_topics_index` onto it's own page, and moved + all the technical papers into this new page. (:pull:`5604`) + 💼 Internal ===========