From 6957bf0f94adb2e5456f5bfd0cd014983b20f856 Mon Sep 17 00:00:00 2001 From: Trey Stafford Date: Fri, 8 Nov 2024 11:06:51 -0700 Subject: [PATCH] Update CONTRIBUTING doc and rename invoke task for rendering notebooks --- CONTRIBUTING.md | 8 ++++---- tasks/docs.py | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0e0e21..d903483 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,10 +66,10 @@ the main, public-facing documentation site. > [!NOTE] Most of the documentation is designed to be generated automatically. > E.g., changes to the API and markdown documents will be automatically -> refelcted in the documentation. The one exception is the -> `iceflow-example.ipynb`, which is static and must be re-generated manually. -> Use the `invoke docs.generate-example-notebook` task to re-generate this file, -> and then commit any changes to the repository. +> 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. # Releasing diff --git a/tasks/docs.py b/tasks/docs.py index 0d224fe..a5ca972 100644 --- a/tasks/docs.py +++ b/tasks/docs.py @@ -50,8 +50,8 @@ def watch(_ctx): @task() -def generate_example_notebook(_ctx): - """Generate the example iceflow notebook for the docs.""" +def render_notebooks_for_docs(_ctx): + """Render jupyter notebooks for docs.""" print_and_run( (f"{PROJECT_DIR}/notebooks/generate_rendered_notebook_for_docs.sh"), pty=True,