chore: changelog

openscm · Sep 12, 2023 · a31d76d · a31d76d
1 parent 6a018e7
commit a31d76d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -17,6 +17,7 @@ python:
       path: .
       extra_requirements:
         - docs
+        - plotting
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,7 @@ Changelog
 master
 ------
 
+- (`#257 <https://github.com/openscm/scmdata/pull/257>`_) Updated to support the latest version of :mod:`notebook`
 - (`#252 <https://github.com/openscm/scmdata/pull/252>`_) Add ``py.typed`` file do downstream packages can use the provided type-hints. Improved the coverage of the type-hints in ``run.py``
 - (`#255 <https://github.com/openscm/scmdata/pull/255>`_) Unpin upper limit of the version of numpy
 - (`#248 <https://github.com/openscm/scmdata/pull/248>`_) Correctly filter the time index of empty ScmRuns. Resolves #245

diff --git a/docs/source/notebooks/README.md b/docs/source/notebooks/README.md
@@ -0,0 +1,11 @@
+# Notebooks
+
+This directory contains notebooks of examples for how to use `scmdata`.
+
+## Jupytext
+
+We use [Jupytext](https://github.com/mwouts/jupytext) to encode the notebooks as standard .py files. This makes
+it easier to version control notebooks as you get a clear, meaningful diffs. Jupytext also enables these notebooks
+to be edited via Jupyter Lab or Jupyter Notebook. 
+
+As part of the CI, these notebooks are run and checked for any errors.