Skip to content

Commit

Permalink
Update CONTRIBUTING doc with info about developing jupyter notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
trey-stafford committed Nov 8, 2024
1 parent 6957bf0 commit 14cb8cd
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,30 @@ Available tasks:
test.typecheck (test.mypy) Run mypy typechecking.
```

# Jupyter Notebooks

There are Jupyter Notebooks showing `iceflow` functionality under `notebooks/`.

To get started with developing existing or new notebooks, first install the
notebook-specific dependencies:

```
pip install --editable .[notebooks]
```

Then:

```
cd notebooks/
jupyter lab
```

Develop notebooks and confirm that they work as expected. Before committing
changes, clear all outputs.

See below for information about adding rendered versions of notebooks to
ReadTheDocs.

# Documentation

This project uses `sphinx` to generate documentation. To work on the docs,
Expand Down Expand Up @@ -69,7 +93,9 @@ the main, public-facing documentation site.
> refelcted in the documentation. The one exception are the jupyter notebooks
> (e.g., `iceflow-example.ipynb`), which are static and must be re-generated
> manually. Use the `invoke docs.render-notebooks-for-docs` task to re-generate
> these files, and then commit any changes to the repository.
> these files, and then commit any changes to the repository. See the
> `notebooks/generate_rendered_notebooks_for_docs.sh` for how to add new
> rendered notebooks to the docs.
# Releasing

Expand Down

0 comments on commit 14cb8cd

Please sign in to comment.