Skip to content

Commit

Permalink
Merge pull request #257 from openscm/remove-jupytext-server-dep
Browse files Browse the repository at this point in the history
Remove jupytext server dependency
  • Loading branch information
lewisjared authored Sep 12, 2023
2 parents 83d9990 + a31d76d commit 5b7d579
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 4 deletions.
1 change: 1 addition & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ python:
path: .
extra_requirements:
- docs
- plotting

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ $(VENV_DIR): setup.py setup.cfg

$(VENV_DIR)/bin/pip install --upgrade pip wheel
$(VENV_DIR)/bin/pip install -e .[dev]
$(VENV_DIR)/bin/jupyter nbextension enable --py widgetsnbextension

# Set jupytext as the default viewer when opening notebooks
$(VENV_DIR)/bin/jupytext-config set-default-viewer

touch $(VENV_DIR)

Expand Down
11 changes: 11 additions & 0 deletions docs/source/notebooks/README.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 1 addition & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ plotting =
notebooks =
%(plotting)s
%(optional)s
notebook
# See https://github.com/jupyter/notebook/issues/5492
jupyter-server<2
notebook>=7
ipywidgets

tests =
Expand Down

0 comments on commit 5b7d579

Please sign in to comment.