Skip to content

Commit

Permalink
Move iris_xarray page into a new Community section.
Browse files Browse the repository at this point in the history
  • Loading branch information
trexfeathers committed Jan 19, 2023
1 parent d3c83b1 commit e19d66e
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 2 deletions.
48 changes: 48 additions & 0 deletions docs/src/community/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
.. include:: ../common_links.inc

.. todo:
consider scientific-python.org
consider scientific-python.org/specs/
Iris in the Community
=====================

Iris aims to be a valuable member of the open source scientific Python
community.

We listen out for developments in our dependencies and neighbouring projects,
and we reach out to them when we can solve problems together; please feel free
to reach out to us!

We are aware of our place in the user's wider 'toolbox' - offering unique
functionality and interoperating smoothly with other packages.

We welcome contributions from all; whether that's an opinion, a 1-line
clarification, or a whole new feature 🙂

Quick Links
-----------

* `GitHub Discussions`_
* :ref:`Getting involved<development_where_to_start>`
* `Twitter <https://twitter.com/scitools_iris>`_

Interoperability
----------------

There's a big choice of Python tools out there! Each one has strengths and
weaknesses in different areas, so we don't want force a single choice for your
whole workflow - we'd much rather make it easy for you to choose the right tool
for the moment, switching whenever you need. Below are our ongoing efforts at
smoother interoperation:

.. not using toctree due to combination of child pages and cross-references.
* The :mod:`iris.pandas` module
* :doc:`iris_xarray`

.. toctree::
:maxdepth: 1
:hidden:

iris_xarray
File renamed without changes.
9 changes: 9 additions & 0 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,15 @@ The legacy support resources:
developers_guide/contributing_getting_involved


.. toctree::
:caption: Community
:maxdepth: 1
:name: community_index
:hidden:

Community <community/index>


.. toctree::
:caption: Iris API
:maxdepth: 1
Expand Down
1 change: 0 additions & 1 deletion docs/src/techpapers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ Extra information on specific technical issues.

um_files_loading.rst
missing_data_handling.rst
iris_xarray.rst
6 changes: 5 additions & 1 deletion docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,12 @@ This document explains the changes made to Iris for this release
and removed an ECMWF link in the ``v1.0`` What's New that was failing the
linkcheck CI. (:pull:`5109`)

#. `@trexfeathers`_ added a new top-level :doc:`/community/index` section,
as a one-stop place to find out about getting involved, and how we relate
to other projects. (:pull:`5025`)

#. The **Iris community**, with help from the **Xarray community**, produced
the :doc:`/techpapers/iris_xarray` page, highlighting the similarities and
the :doc:`/community/iris_xarray` page, highlighting the similarities and
differences between the two packages. (:pull:`5025`)

💼 Internal
Expand Down

0 comments on commit e19d66e

Please sign in to comment.