Skip to content

Commit

Permalink
Update CONTRIBUTING doc and rename invoke task for rendering notebooks
Browse files Browse the repository at this point in the history
  • Loading branch information
trey-stafford committed Nov 8, 2024
1 parent fe91a15 commit 6957bf0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions tasks/docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 6957bf0

Please sign in to comment.