Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

!EX! Relocate Technical Papers, with some changes to structure #5604

Closed
wants to merge 5 commits into from
Closed

!EX! Relocate Technical Papers, with some changes to structure #5604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
340a97f
moved technical papers to further topics
ESadek-MO Nov 24, 2023
c74bdf2
updated old whatsnew
ESadek-MO Nov 24, 2023
0d84914
removed line 64
ESadek-MO Nov 24, 2023
cece9ca
Technical Paper POC
ESadek-MO Nov 24, 2023
93f4557
added a whatsnew
ESadek-MO Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/src/developers_guide/contributing_getting_involved.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,5 @@ If you are new to using GitHub we recommend reading the

../generated/api/iris
../whatsnew/index
../techpapers/index
../copyright
../voted_issues
20 changes: 20 additions & 0 deletions docs/src/further_topics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
0 .../src/techpapers/missing_data_handling.rst → .../further_topics/missing_data_handling.rst
View file
Open in desktop
File renamed without changes.
0 docs/src/techpapers/netcdf_io.rst → docs/src/further_topics/netcdf_io.rst
View file
Open in desktop
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/src/techpapers/um_files_loading.rst → docs/src/further_topics/um_files_loading.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _um_files_loading:

.. testsetup::

import numpy as np
Expand All @@ -13,6 +11,8 @@
np.set_printoptions(precision=8)


.. _um_files_loading:

===================================
Iris Handling of PP and Fieldsfiles
===================================
Expand Down
8 changes: 8 additions & 0 deletions docs/src/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,12 @@ The legacy support resources:
Iris API <generated/api/iris>


.. toctree::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it is this which adds the unwanted extra top section.
Since this part appears at the end of the User Guide overview page, do we actually need this here ??

Disclaimer : I don't really understand this stuff.
( But at least I know it )

Copy link
Contributor Author

@ESadek-MO ESadek-MO Nov 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It no longer does appear at the end of the User Guide overview, see the docs built from this PR.

By making it it's own section, I've removed it from the user guide toctree. This also removes it in the overview. Currently the only way to access this is through the navbar.

:caption: Further Topics
:maxdepth: 1
:hidden:

Further Topics <further_topics/index>


.. todolist::
14 changes: 0 additions & 14 deletions docs/src/techpapers/index.rst
View file
Open in desktop

This file was deleted.

13 changes: 1 addition & 12 deletions docs/src/userguide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ they may serve as a useful reference for future exploration.


.. toctree::
:maxdepth: 2
:maxdepth: 1

iris_cubes
loading_iris_cubes
Expand All @@ -37,14 +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
4 changes: 2 additions & 2 deletions docs/src/whatsnew/1.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,6 @@ Documentation
* A clarification of the behaviour of
:func:`iris.analysis.calculus.differentiate`.

* A new :doc:`"Technical Papers" </techpapers/index>` section has been added to
* A new Technical Papers section has been added to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could now be pointed a the new combined "further topics" page ?
I thought that was part of the reason for the new page !

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the 1.7 what's new; whereas all I had done was move where the Tech Papers section was, now I've removed it altogether. To change the path to further topics seems non-representative.

The file I've linked to because the file hasn't changed.

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) </techpapers/um_files_loading>`.
:ref:`overview of the load process for UM-like fileformats (e.g. PP and Fieldsfile) <um_files_loading>`.
3 changes: 3 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
===========
Expand Down
Loading