Skip to content

Commit

Permalink
documentation: (marimo) use jupyter notebooks for easier reviewing (#…
Browse files Browse the repository at this point in the history
…3722)

GitHub already has custom UIs for Jupyter notebooks, this will let us
more easily review the marimo notebook changes using that UI.
  • Loading branch information
superlopuh authored Jan 8, 2025
1 parent 20290ae commit be78282
Show file tree
Hide file tree
Showing 7 changed files with 1,203 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci-notebooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
- name: Run examples/tutorials
run: |
# mlir_interoperation.ipynb is dependent on MLIR, and is tested in the MLIR-enabled workflow.
uv run pytest -W error --nbval -vv docs --ignore=docs/mlir_interoperation.ipynb
uv run pytest -W error --nbval -vv docs --ignore=docs/mlir_interoperation.ipynb --ignore-glob=**/__marimo__/*.ipynb
- name: Test marimo notebooks
run: |
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ pytest-nb: uv-installed
uv run pytest -W error --nbval -vv docs \
--ignore=docs/mlir_interoperation.ipynb \
--ignore=docs/Toy \
--ignore-glob=**/__marimo__/*.ipynb \
--nbval-current-env

# run tests for Toy tutorial
Expand Down
770 changes: 770 additions & 0 deletions docs/marimo/__marimo__/linalg_snitch.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/marimo/linalg_snitch.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import marimo

__generated_with = "0.10.9"
app = marimo.App(width="medium")
app = marimo.App(width="medium", auto_download=["ipynb"])


@app.cell
Expand Down
Loading

0 comments on commit be78282

Please sign in to comment.