euro-cordex · larsbuntemeyer · Jun 24, 2024 · Jun 24, 2024 · Jun 24, 2024 · Jun 24, 2024
diff --git a/README.rst b/README.rst
@@ -20,20 +20,34 @@ This package offers python tools for the `CORDEX <https://cordex.org/>`_ communi
 Most of the tools leverage the ``xarray`` API to create grid and coordinate informations and data of CORDEX domains in the
 form of an ``xarray.Dataset`` directly from the official `CORDEX archive specifications <https://cordex.org/experiment-guidelines/experiment-protocol-rcms/>`_.
 
+Please have a look at the `introduction noteboook <https://py-cordex.readthedocs.io/en/latest/notebooks/introduction.html>`_!
+
 Features
 --------
 
 * Tools to manage CORDEX grids as xarray datasets.
 * Includes coordinate transformations, bounds and vertices for CORDEX datasets.
 * Utitlities for cmorization to make the CORDEX ensembles more consistent.
-* Preprocessing for easy access to a homogenized CORDEX ensemble dataset.
 
-For planned features, please have a look at the `issues <https://github.com/euro-cordex/py-cordex/issues>`_, grab one, and `contribute <https://py-cordex.readthedocs.io/en/latest/contributing.html>`_!
+You can use this package, e.g., to easily access CORDEX grid definitions:
+
+.. code-block:: python
+    import cordex as cx
+
+    cx.domain("EUR-11")
+
+to create an xarray Dataset:
+
+.. image:: https://raw.githubusercontent.com/euro-cordex/py-cordex/main/docs/eur-11_xarray.png
 
-Meta data
-^^^^^^^^^
-Access to meta data should be automatic and machine readable to avoid humans to do boring, repetitiv tasks that are error prone.
-For that purpose, easy access to meta information should be guaranteed by tables collected `here <https://github.com/euro-cordex/tables>`_.
+and make a quick plot using the accessor:
+
+.. code-block:: python
+    cx.domain("EUR-11").cx.plot()
+
+.. image:: https://raw.githubusercontent.com/euro-cordex/py-cordex/main/docs/eur-11.png
+
+For planned features, please have a look at the `issues <https://github.com/euro-cordex/py-cordex/issues>`_, grab one, and `contribute <https://py-cordex.readthedocs.io/en/latest/contributing.html>`_!
 
 Installation
 ------------
@@ -58,7 +72,6 @@ For instructions to install py-cordex from source, please have a look at the
 If you want to contribute, please get in contact as early as possible, e.g.,
 using `draft pull requests <https://github.blog/2019-02-14-introducing-draft-pull-requests>`_.
 
-
 Credits
 -------
 

diff --git a/ci/requirements/docs.yml b/ci/requirements/docs.yml
@@ -3,7 +3,7 @@ channels:
   - conda-forge
 dependencies:
   - python=3.10
-  - docutils=0.20 # see https://github.com/euro-cordex/py-cordex/issues/243
+  - docutils
   - pint-xarray
   - matplotlib-base
   - xarray
@@ -13,7 +13,6 @@ dependencies:
   - pillow
   - pip
   - nbsphinx
-  - nbsphinx-link
   - ipython
   - cftime
   - pooch
@@ -27,6 +26,4 @@ dependencies:
   - pydata-sphinx-theme
   - sphinx-book-theme>=0.3.3
   - sphinx-autosummary-accessors
-  - pip:
-    - sphinxcontrib-mockautodoc
-    - myst_nb
+  - myst-nb
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,11 +40,10 @@
     "sphinx.ext.extlinks",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
-    "sphinxcontrib.mockautodoc",
+    #    "sphinxcontrib.mockautodoc",
     "numpydoc",
     "sphinx_autosummary_accessors",
     "nbsphinx",
-    "nbsphinx_link",
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
 ]
@@ -55,8 +54,6 @@
     "pull": ("https://github.com/euro-cordex/py-cordex/pull/%s", "#%s"),
 }
 
-autodoc_mock_imports = ["cartopy", "xesmf", "geopandas", "matplotlib", "regionmask"]
-
 autosummary_generate = True
 
 napoleon_use_param = True

diff --git a/docs/domains.nblink b/docs/domains.nblink
diff --git a/docs/eur-11.png b/docs/eur-11.png
diff --git a/docs/eur-11_xarray.png b/docs/eur-11_xarray.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,7 @@
    :caption: Tutorial
 
    notebooks/introduction
-   prudence
+   notebooks/prudence
 
 .. toctree::
    :maxdepth: 2

diff --git a/notebooks/cordex-preprocessing.ipynb → docs/notebooks/cordex-preprocessing.ipynb b/notebooks/cordex-preprocessing.ipynb → docs/notebooks/cordex-preprocessing.ipynb
diff --git a/notebooks/domains.ipynb → docs/notebooks/domains.ipynb b/notebooks/domains.ipynb → docs/notebooks/domains.ipynb
diff --git a/notebooks/esgf.ipynb → docs/notebooks/esgf.ipynb b/notebooks/esgf.ipynb → docs/notebooks/esgf.ipynb
diff --git a/notebooks/euro-cordex-ensemble.ipynb → docs/notebooks/euro-cordex-ensemble.ipynb b/notebooks/euro-cordex-ensemble.ipynb → docs/notebooks/euro-cordex-ensemble.ipynb
diff --git a/notebooks/mask.ipynb → docs/notebooks/mask.ipynb b/notebooks/mask.ipynb → docs/notebooks/mask.ipynb
diff --git a/notebooks/preprocessing.ipynb → docs/notebooks/preprocessing.ipynb b/notebooks/preprocessing.ipynb → docs/notebooks/preprocessing.ipynb
diff --git a/docs/notebooks/prudence.ipynb b/docs/notebooks/prudence.ipynb
diff --git a/notebooks/regions.ipynb → docs/notebooks/regions.ipynb b/notebooks/regions.ipynb → docs/notebooks/regions.ipynb
diff --git a/notebooks/weighted-masking.ipynb → docs/notebooks/weighted-masking.ipynb b/notebooks/weighted-masking.ipynb → docs/notebooks/weighted-masking.ipynb
diff --git a/docs/prudence.nblink b/docs/prudence.nblink
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -23,9 +23,10 @@ New Features
 Internal Changes
 ~~~~~~~~~~~~~~~~
 
-- Pin ``pint!=0.24`` due to breaking changes that affect ``cf_xarray`` (:pull:`249`).
-- Changed ``CORDEX_domain`` keyword to ``domain_id`` in :py:meth:`cmor.cmorize_variable`, added deprecation warning (:pull:`252`).
+- Removed ``nbspinx_link`` dependency from documentation (:pull:`256`).
 - Added :py:meth:`domain` which is equivalent to earlier ``cordex_domain`` (:pull:`254`).
+- Changed ``CORDEX_domain`` keyword to ``domain_id`` in :py:meth:`cmor.cmorize_variable`, added deprecation warning (:pull:`252`).
+- Pin ``pint!=0.24`` due to breaking changes that affect ``cf_xarray`` (:pull:`249`).
 
 v0.7.1 (4 June 2024)
 --------------------

diff --git a/notebooks/prudence.ipynb b/notebooks/prudence.ipynb