Skip to content

Added text to state the Python version used to build the docs. - #3989

Merged
bjlittle merged 5 commits into
SciTools:masterfrom
tkknight:docs_build_python_version
Feb 9, 2021
Merged

Added text to state the Python version used to build the docs.#3989
bjlittle merged 5 commits into
SciTools:masterfrom
tkknight:docs_build_python_version

Conversation

@tkknight

@tkknighttkknight commented Feb 8, 2021

Copy link
Copy Markdown
Contributor

🚀 Pull Request

Description

Add explicit statement of which version Python is used when building the documentation. This includes:

  • Using the Python version as defined in the variable build_python_version. This builds upon the changes from automate docs discovery of iris and python versions #3981.
  • Updating the installing page to state the Python version in the note.
  • Added the build_python_version to the html_context variable in conf.py to allow it to be used in the templating for the footer.html.

For the lifetime of this PR the docs can be seen here: https://tkknight-iris-test-doc.readthedocs.io/en/latest/index.html. Note:


Consult Iris pull request check list

@tkknight
tkknight marked this pull request as ready for review February 8, 2021 12:54
@bjlittlebjlittle self-assigned this Feb 8, 2021

@bjlittlebjlittle left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@tkknight Very nice, thanks! 👍

Just a couple of suggestions - let me know what you think

Comment threaddocs/src/conf.py Outdated
Comment threaddocs/src/developers_guide/contributing_documentation.rst Outdated
Comment threaddocs/src/installing.rst Outdated
Comment threaddocs/src/conf.py
@bjlittle

Copy link
Copy Markdown
Member

@tkknight LGTM

Did you want to add a suitable whatsnew entry?

Then we can bank this, thanks!

@bjlittle
bjlittle merged commit c51dab2 into SciTools:masterFeb 9, 2021
tkknight added a commit to tkknight/iris that referenced this pull request Feb 9, 2021
* master: (23 commits)
Added text to state the Python version used to build the docs. (SciTools#3989)
add nox session conda list (SciTools#3990)
Add abstract cube summary (SciTools#3987)
automate docs discovery of iris and python versions (SciTools#3981)
corrected syntax (SciTools#3980)
core dev whatsnew entry (SciTools#3978)
moved docs dir and updated references to it (SciTools#3975)
Fix test_incompatible_dimensions test (SciTools#3977)
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)
Put cube data on the x axis if plotting just a cube against a vertical or y coordinate (SciTools#3906)
remove stock_mdi_arrays.npz (SciTools#3913)
Gallery: update seasonal ensemble example (SciTools#3933)
...
trexfeathers pushed a commit that referenced this pull request Feb 15, 2021
* 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>
trexfeathers pushed a commit that referenced this pull request Feb 15, 2021
* 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>
trexfeathers pushed a commit that referenced this pull request Feb 22, 2021
* 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>
@tkknight
tkknight deleted the docs_build_python_version branch February 22, 2021 14:31
trexfeathers pushed a commit that referenced this pull request Feb 22, 2021
* 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>
bjlittle added a commit that referenced this pull request Feb 23, 2021
* 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>
bjlittle added a commit that referenced this pull request Feb 25, 2021
* 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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@tkknight@bjlittle