Document changes in whatsnew, close #6 and #11.

doc/conf.py

@@ -32,6 +32,10 @@
     'examples_dirs': '../examples',  # path to example scripts
     'gallery_dirs': 'examples',     # where to save gallery plots
     }
+extlinks = {
+    "issue": ("https://github.com/pydata/xarray/issues/%s", "#"),
+    "pull": ("https://github.com/pydata/xarray/pull/%s", "PR"),
+}
 intersphinx_mapping = {
     'matplotlib': ('https://matplotlib.org/stable/', None),
     'python': ('https://docs.python.org/3.7/', None),

doc/whatsnew.rst

@@ -1,9 +1,52 @@
 .. Copyright (c) 2021, Julien Seguinot (juseg.github.io)
 .. GNU General Public License v3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt)
 
+.. currentmodule:: hyoga
+
+.. What's new sections, cheated on xarray
+   - Breaking changes
+   - Deprecations
+   - New Features
+   - Bug fixes
+   - Documentation
+   - Internal Changes
+
+
 What's new
 ==========
 
+v0.1.1
+------
+
+This release includes a minor bug fix and several documentation improvements.
+
+
+Deprecations
+~~~~~~~~~~~~
+
+- Functions :func:`demo.pism_gridded` and :func:`demo.pism_series` are
+  deprecated. Use ``demo.get('pism.alps.out.2d')`` and
+  ``demo.get('pism.alps.out.1d')`` instead.
+
+
+Bug fixes
+~~~~~~~~~
+
+- Assign surface altitude during :meth:`HyogaDataset.interp` if it is missing,
+  as it is needed to compute the interpolated ice mask.
+
+
+Documentation
+~~~~~~~~~~~~~
+
+- Examples in the documentation use smaller files currently hosted in a
+  separate Github repository `hyoga-data <https://github/juseg/hyoga-data>`_
+  (:issue:`11`). You may want to delete the previous, 400 MB file in
+  ``~/.cache/hyoga``.
+- New examples have been added to demonstrate plotting bedrock isostasy and
+  interpolated model output (:doc:`examples/index`, :issue:`11`).
+
+
 v0.1.0 "Akaishi"
 ----------------
 

hyoga/hyoga.py

@@ -271,7 +271,8 @@ def interp(self, datasource, ax=None, sigma=None, threshold=1):
         dataset : Dataset
             The interpolated dataset, with new horizontal resolution
             corresponding to either the data provided in ``datasource``, or
-            the pixel count of axes provided with ``ax``.
+            the pixel count of axes provided with ``ax``. The ice surface
+            altitude will be assigned if missing, to compute a detailed mask.
         """
 
         # read topography from file if it is not an array