File tree Expand file tree Collapse file tree 2 files changed +6
-6
lines changed Expand file tree Collapse file tree 2 files changed +6
-6
lines changed Original file line number Diff line number Diff line change @@ -66,10 +66,10 @@ the main, public-facing documentation site.
6666
6767> [ !NOTE] Most of the documentation is designed to be generated automatically.
6868> E.g., changes to the API and markdown documents will be automatically
69- > refelcted in the documentation. The one exception is the
70- > ` iceflow-example.ipynb ` , which is static and must be re-generated manually.
71- > Use the ` invoke docs.generate-example-notebook ` task to re-generate this file,
72- > and then commit any changes to the repository.
69+ > refelcted in the documentation. The one exception are the jupyter notebooks
70+ > (e.g., ` iceflow-example.ipynb ` ) , which are static and must be re-generated
71+ > manually. Use the ` invoke docs.render-notebooks-for-docs ` task to re-generate
72+ > these files, and then commit any changes to the repository.
7373
7474# Releasing
7575
Original file line number Diff line number Diff line change @@ -50,8 +50,8 @@ def watch(_ctx):
5050
5151
5252@task ()
53- def generate_example_notebook (_ctx ):
54- """Generate the example iceflow notebook for the docs."""
53+ def render_notebooks_for_docs (_ctx ):
54+ """Render jupyter notebooks for docs."""
5555 print_and_run (
5656 (f"{ PROJECT_DIR } /notebooks/generate_rendered_notebook_for_docs.sh" ),
5757 pty = True ,
You can’t perform that action at this time.
0 commit comments