Docs unreleased banner #3999

tkknight · 2021-02-10T17:37:21Z

🚀 Pull Request

Description

For a better user experience it would be useful for the documentation to clearly state when you are viewing the latest unreleased docs (from master).

This change uses the _templates/layout.html to add extra content, in this case to the document block (the "body" content of every page on the docs).

The rendered documentation for this PR: https://tkknight-iris-test-doc.readthedocs.io/en/latest/ (may change until this PR is out of draft)

This is a part solution to #3992.

Logic that triggers showing the notice

When the docs are built on the Read the Docs service there is a shell environment variable named READTHEDOCS_VERSION that should be set to: latest / stable / v3.0.1/ etc. This variable is pulled into conf.py and then passed into the sphinx build via the html_context variable.

The banner/notice will only be shown when rendering on the read the docs service and when using the latest (against master) docs.

Presentation style of the notice

The logic and the banner is in the _templates/layout.html file, using the document block (see https://www.sphinx-doc.org/en/master/templating.html).

The document means the banner would be added at the top of the body of every page on the docs. If the user scrolls down the banner will not be visible.

I have tried variations where the banner is fixed at the top of every page but my css skills are limited and it would render over the top of the existing content, meaning the iris logo was a little overwitten - so I aborted this approach.

TO DO

Choose (or another option) the presentation style of the notice.
- Option 1: Red banner (needs a little bit of css to create). This is the one that will be used
- Option 2: Use a read the docs theme note/warning. This fits with the styliing, however it may not be as visible to users as a red banner.

Consult Iris pull request check list

* master: update setuptools description (SciTools#4008) update readme logo img src and href (SciTools#4006) update readme badges (SciTools#4004) update intersphinx mapping and matplotlib urls (SciTools#4003)

* master: update release process (SciTools#4010) cirrus-ci compute credits (SciTools#4007)

rcomer

I like the red. Can't miss it!

docs/src/_templates/layout.html

bjlittle · 2021-02-19T12:16:30Z

@tkknight I've taken this out of draft... It's ready for review, right?

Remove alternative banner that used the RestructuredText notation.

tkknight · 2021-02-19T12:36:09Z

@tkknight I've taken this out of draft... It's ready for review, right?

Just removed the alternate banner. Once the docs have finished building it will be ready for review.

bjlittle · 2021-02-19T12:44:11Z

Just ping me when it's good to go, and I'll get to it asap 👍

tkknight · 2021-02-19T13:00:49Z

Just ping me when it's good to go, and I'll get to it asap 👍

Ping @bjlittle. Took a little bit to pass the cirrus checks. The link check got stuck. I cancelled the task and rerun manually, passed ok.

bjlittle · 2021-02-19T13:19:52Z

docs/src/whatsnew/latest.rst

@@ -91,6 +91,9 @@ This document explains the changes made to Iris for this release

 #. `@bjlittle`_ added the |PyPI|_ badge to the `README.md`_. (:pull:`4004`)

+#. `@tkknight`_ added a banner at the top of every page if the unreleased
+   development documentatiion is being viewed. (:pull:`3999`)
+


@tkknight could you add clarification to the reader that this only applies to rtd... that's how I understand it, right?

Typo "documentatiion"

tkknight · 2021-02-20T11:15:14Z

finally, maybe, possibly, good to go.

bjlittle

@tkknight LGTM 👍

Awesome, thanks!

* Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) * cirrus-ci compute credits (#4007) * update release process (#4010) * Stop using deprecated aliases of builtin types (#3997) * Stopped using deprecated aliases of builtin types. This is required to avoid warnings starting with NumPy 1.20.0. * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Updated whatsnew. Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * celebrate first time iris contributors (#4013) * Docs unreleased banner (#3999) * baseline * removed debug comments * reverted * remove line * Testing * testing extensions * testing rtd_version * fixed if * removed line * tidy up * tidy comments * debug of pre-existing rtd variables * added reminder * testing * testing still * updated comments * added whatsnew * expanded the if conditiion * review actions * Update layout.html Remove alternative banner that used the RestructuredText notation. * review actions * drop __unicode__ method usage (#4018) * cirrus-ci conditional tasks (#4019) * cirrus-ci conditional tasks * use bc for bash arithmetic * revert back to sed * use expr * reword * minor documentation changes * review actions * make iris.common.metadata._hexdigest public (#4020) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com>

* Update mesh-data-model branch (#4009) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> * Master to mesh data model (#4022) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) * cirrus-ci compute credits (#4007) * update release process (#4010) * Stop using deprecated aliases of builtin types (#3997) * Stopped using deprecated aliases of builtin types. This is required to avoid warnings starting with NumPy 1.20.0. * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Updated whatsnew. Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * celebrate first time iris contributors (#4013) * Docs unreleased banner (#3999) * baseline * removed debug comments * reverted * remove line * Testing * testing extensions * testing rtd_version * fixed if * removed line * tidy up * tidy comments * debug of pre-existing rtd variables * added reminder * testing * testing still * updated comments * added whatsnew * expanded the if conditiion * review actions * Update layout.html Remove alternative banner that used the RestructuredText notation. * review actions * drop __unicode__ method usage (#4018) * cirrus-ci conditional tasks (#4019) * cirrus-ci conditional tasks * use bc for bash arithmetic * revert back to sed * use expr * reword * minor documentation changes * review actions * make iris.common.metadata._hexdigest public (#4020) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com>

* add ugrid mesh-api stubs (#4001) * add additional mesh stubs (#4005) * Update mesh-data-model branch (#4009) (#4011) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> * MeshMetadata class. (#4002) * MeshMetadata class. * MeshMetadata extra members for dim names. * Comment for BaseMetadata refactoring. * add meshmetadata services (#4012) * Mesh api coord manager (#4015) * add mesh coordinate manager * wip * make shape methods private + reorganise method order * review actions * partial mesh * wip * Mesh data model to ng vat mesh api (#4023) * Update mesh-data-model branch (#4009) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> * Master to mesh data model (#4022) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) * cirrus-ci compute credits (#4007) * update release process (#4010) * Stop using deprecated aliases of builtin types (#3997) * Stopped using deprecated aliases of builtin types. This is required to avoid warnings starting with NumPy 1.20.0. * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Updated whatsnew. Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * celebrate first time iris contributors (#4013) * Docs unreleased banner (#3999) * baseline * removed debug comments * reverted * remove line * Testing * testing extensions * testing rtd_version * fixed if * removed line * tidy up * tidy comments * debug of pre-existing rtd variables * added reminder * testing * testing still * updated comments * added whatsnew * expanded the if conditiion * review actions * Update layout.html Remove alternative banner that used the RestructuredText notation. * review actions * drop __unicode__ method usage (#4018) * cirrus-ci conditional tasks (#4019) * cirrus-ci conditional tasks * use bc for bash arithmetic * revert back to sed * use expr * reword * minor documentation changes * review actions * make iris.common.metadata._hexdigest public (#4020) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com> * Connectivity manager (#4017) * ConnectivityManager first pass. * ConnectivityManager align with proposed CoordManager. * Connectivity Manager review actions. * Connectivity Manager more review changes. * Use metadata_manager for Mesh location dimension. * Mesh dimension name abstraction. * Align Cooord and Connectivity Managers filters methods. * Completed Mesh class. * filter_cf improvements. * Moved filter_cf. * Mesh connectivity manager namedtuples comment. * Mesh removed trailing underscores. * Mesh _set_dimension_names improvements. * Mesh import rationalisation. * Mesh connectivity manager remove NDIM. * Connectivity manager use lazy indices_by_src(). * Connectivity manager clearer removal syntax. * Connectivity manager don't override __init__. * Connectivity manager correct base class syntax. * Metadata filter hexdigest reference fix. * test_MeshMetadata fix. * Rename filter to metadata_filter. * minor fixes (#4025) * minor fixes * wip * add mesh pickle support (#4026) Co-authored-by: Bill Little <bill.james.little@gmail.com> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com>

* add ugrid mesh-api stubs (#4001) * add additional mesh stubs (#4005) * Update mesh-data-model branch (#4009) (#4011) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> * MeshMetadata class. (#4002) * MeshMetadata class. * MeshMetadata extra members for dim names. * Comment for BaseMetadata refactoring. * add meshmetadata services (#4012) * Mesh api coord manager (#4015) * add mesh coordinate manager * wip * make shape methods private + reorganise method order * review actions * partial mesh * wip * Mesh data model to ng vat mesh api (#4023) * Update mesh-data-model branch (#4009) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> * Master to mesh data model (#4022) * Add abstract cube summary (#3987) Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> * add nox session conda list (#3990) * Added text to state the Python version used to build the docs. (#3989) * Added text to state the Python version used to build the docs. * Added footer template that includes the Python version used to build. * added new line * Review actions * added whatsnew * Iris py38 (#3976) * support for py38 * update CI and noxfile * enforce alphabetical xml element attribute order * full tests for py38 + fix docs-tests * add whatsnew entry * update doc-strings + review actions * Alternate xml handling routine (#29) * all xml tests pass for nox tests-3.8 * restored docstrings * move sort_xml_attrs * make sort_xml_attrs a classmethod * update sort_xml_attr doc-string Co-authored-by: Bill Little <bill.james.little@gmail.com> * add jamesp to whatsnew + minor tweak Co-authored-by: James Penn <james@jamespenn.co.uk> * normalise version to implicit development release number (#3991) * Gallery: update COP maps example (#3934) * update cop maps example * comment tweaks * minor comment tweak + whatsnew * reinstate whatsnew addition * remove duplicate whatsnew * don't support mpl v1.2 (#3941) * Cubesummary tidy (#3988) * Extra tests; fix for array attributes. * Docstring for CubeSummary, and remove some unused parts. * Fix section name capitalisation, in line with existing cube summary. * Handle array differences; quote strings in extras and if 'awkward'-printing. * Ensure scalar string coord 'content' prints on one line. * update intersphinx mapping and matplotlib urls (#4003) * update intersphinx mapping and matplotlib urls * use matplotlib intersphinx where possible * review actions * review actions * update readme badges (#4004) * update readme badges * pimp twitter badge * update readme logo img src and href (#4006) * update setuptools description (#4008) * cirrus-ci compute credits (#4007) * update release process (#4010) * Stop using deprecated aliases of builtin types (#3997) * Stopped using deprecated aliases of builtin types. This is required to avoid warnings starting with NumPy 1.20.0. * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Update lib/iris/tests/test_cell.py Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * Updated whatsnew. Co-authored-by: Bill Little <bill.little@metoffice.gov.uk> * celebrate first time iris contributors (#4013) * Docs unreleased banner (#3999) * baseline * removed debug comments * reverted * remove line * Testing * testing extensions * testing rtd_version * fixed if * removed line * tidy up * tidy comments * debug of pre-existing rtd variables * added reminder * testing * testing still * updated comments * added whatsnew * expanded the if conditiion * review actions * Update layout.html Remove alternative banner that used the RestructuredText notation. * review actions * drop __unicode__ method usage (#4018) * cirrus-ci conditional tasks (#4019) * cirrus-ci conditional tasks * use bc for bash arithmetic * revert back to sed * use expr * reword * minor documentation changes * review actions * make iris.common.metadata._hexdigest public (#4020) Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com> * Connectivity manager (#4017) * ConnectivityManager first pass. * ConnectivityManager align with proposed CoordManager. * Connectivity Manager review actions. * Connectivity Manager more review changes. * Use metadata_manager for Mesh location dimension. * Mesh dimension name abstraction. * Align Cooord and Connectivity Managers filters methods. * Completed Mesh class. * filter_cf improvements. * Moved filter_cf. * Mesh connectivity manager namedtuples comment. * Mesh removed trailing underscores. * Mesh _set_dimension_names improvements. * Mesh import rationalisation. * Mesh connectivity manager remove NDIM. * Connectivity manager use lazy indices_by_src(). * Connectivity manager clearer removal syntax. * Connectivity manager don't override __init__. * Connectivity manager correct base class syntax. * Metadata filter hexdigest reference fix. * test_MeshMetadata fix. * Rename filter to metadata_filter. * minor fixes (#4025) * minor fixes * wip * add mesh pickle support (#4026) * Test Mesh WIP. * Mesh face_dimension not set for topology_dimension=1. * Mesh testing WIP. * Mesh tests WIP. * Mesh tests WIP. * Mesh tests complete. * Mesh repr tests. * experimental.ugrid restore class ordering. * Mesh tests - move global and class variables into setUpClass methods, to play nicely with unittest. * Delete commented code. * Mesh clearer distinction between coords and connectivities filters. * Mesh tests slight readability improvement. Co-authored-by: Bill Little <bill.james.little@gmail.com> Co-authored-by: Patrick Peglar <patrick.peglar@metoffice.gov.uk> Co-authored-by: stephen.worsley <stephen.worsley@metoffice.gov.uk> Co-authored-by: tkknight <2108488+tkknight@users.noreply.github.com> Co-authored-by: James Penn <james@jamespenn.co.uk> Co-authored-by: Ruth Comer <ruth.comer@metoffice.gov.uk> Co-authored-by: Alexander Kuhn-Regnier <ahf.kuhnregnier@gmail.com>

tkknight added 20 commits February 10, 2021 17:05

baseline

96131f5

removed debug comments

d2bc328

reverted

72ffba2

remove line

1313014

Testing

d70d856

testing extensions

bbe0346

testing rtd_version

82d976c

fixed if

706a8fd

removed line

0d54f02

tidy up

1c3efaa

tidy comments

da2510f

debug of pre-existing rtd variables

b131337

added reminder

153fa2c

Merge branch 'master' into docs_unreleased_banner

962205e

* master: update setuptools description (SciTools#4008) update readme logo img src and href (SciTools#4006) update readme badges (SciTools#4004) update intersphinx mapping and matplotlib urls (SciTools#4003)

testing

adad28c

testing still

271314a

updated comments

ea7459c

Merge branch 'master' into docs_unreleased_banner

37599ee

* master: update release process (SciTools#4010) cirrus-ci compute credits (SciTools#4007)

added whatsnew

3bba3dc

expanded the if conditiion

bef1feb

rcomer reviewed Feb 17, 2021

View reviewed changes

docs/src/_templates/layout.html Outdated Show resolved Hide resolved

docs/src/_templates/layout.html Outdated Show resolved Hide resolved

review actions

9943d44

bjlittle marked this pull request as ready for review February 19, 2021 12:15

bjlittle closed this Feb 19, 2021

bjlittle reopened this Feb 19, 2021

bjlittle self-requested a review February 19, 2021 12:17

bjlittle added New: Pull Request Type: Documentation labels Feb 19, 2021

bjlittle self-assigned this Feb 19, 2021

Update layout.html

14d9b12

Remove alternative banner that used the RestructuredText notation.

bjlittle reviewed Feb 19, 2021

View reviewed changes

review actions

be4a586

bjlittle approved these changes Feb 20, 2021

View reviewed changes

bjlittle merged commit 065970a into SciTools:master Feb 20, 2021

tkknight mentioned this pull request Feb 20, 2021

Which version is stable? #3992

Closed

tkknight deleted the docs_unreleased_banner branch February 22, 2021 14:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs unreleased banner #3999

Docs unreleased banner #3999

tkknight commented Feb 10, 2021 •

edited

Loading

rcomer left a comment

bjlittle commented Feb 19, 2021

tkknight commented Feb 19, 2021

bjlittle commented Feb 19, 2021

tkknight commented Feb 19, 2021

bjlittle Feb 19, 2021

rcomer Feb 19, 2021 •

edited

Loading

tkknight commented Feb 20, 2021

bjlittle left a comment

Docs unreleased banner #3999

Docs unreleased banner #3999

Conversation

tkknight commented Feb 10, 2021 • edited Loading

🚀 Pull Request

Description

Logic that triggers showing the notice

Presentation style of the notice

TO DO

rcomer left a comment

Choose a reason for hiding this comment

bjlittle commented Feb 19, 2021

tkknight commented Feb 19, 2021

bjlittle commented Feb 19, 2021

tkknight commented Feb 19, 2021

bjlittle Feb 19, 2021

Choose a reason for hiding this comment

rcomer Feb 19, 2021 • edited Loading

Choose a reason for hiding this comment

tkknight commented Feb 20, 2021

bjlittle left a comment

Choose a reason for hiding this comment

tkknight commented Feb 10, 2021 •

edited

Loading

rcomer Feb 19, 2021 •

edited

Loading