File tree Expand file tree Collapse file tree 1 file changed +27
-1
lines changed Expand file tree Collapse file tree 1 file changed +27
-1
lines changed Original file line number Diff line number Diff line change @@ -40,6 +40,30 @@ Available tasks:
4040 test.typecheck (test.mypy) Run mypy typechecking.
4141```
4242
43+ # Jupyter Notebooks
44+
45+ There are Jupyter Notebooks showing ` iceflow ` functionality under ` notebooks/ ` .
46+
47+ To get started with developing existing or new notebooks, first install the
48+ notebook-specific dependencies:
49+
50+ ```
51+ pip install --editable .[notebooks]
52+ ```
53+
54+ Then:
55+
56+ ```
57+ cd notebooks/
58+ jupyter lab
59+ ```
60+
61+ Develop notebooks and confirm that they work as expected. Before committing
62+ changes, clear all outputs.
63+
64+ See below for information about adding rendered versions of notebooks to
65+ ReadTheDocs.
66+
4367# Documentation
4468
4569This project uses ` sphinx ` to generate documentation. To work on the docs,
@@ -69,7 +93,9 @@ the main, public-facing documentation site.
6993> refelcted in the documentation. The one exception are the jupyter notebooks
7094> (e.g., ` iceflow-example.ipynb ` ), which are static and must be re-generated
7195> manually. Use the ` invoke docs.render-notebooks-for-docs ` task to re-generate
72- > these files, and then commit any changes to the repository.
96+ > these files, and then commit any changes to the repository. See the
97+ > ` notebooks/generate_rendered_notebooks_for_docs.sh ` for how to add new
98+ > rendered notebooks to the docs.
7399
74100# Releasing
75101
You can’t perform that action at this time.
0 commit comments