Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@ on:
- "zensical.toml"
- ".readthedocs.yaml"
- "dev/render_example_notebooks.py"
- "dev/render_marimo_notebooks.py"
- ".github/workflows/docs.yml"
pull_request:
paths:
- "docs/**"
- "zensical.toml"
- ".readthedocs.yaml"
- "dev/render_example_notebooks.py"
- "dev/render_marimo_notebooks.py"
- ".github/workflows/docs.yml"

jobs:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ dev_utils/BioLogic.py_tmp

dev_utils/.ipynb_checkpoints
*.ipynb_checkpoints
__marimo__/

# Distribution / packaging
.Python
Expand Down
17 changes: 11 additions & 6 deletions .issueflows/04-designs-and-guides/marimo-docs.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# Marimo notebooks in the docs

**Context:** Issue #724 — prove marimo can ship alongside Jupyter tutorials under Zensical.
**Context:** Issue #724 — spike to ship marimo alongside Jupyter tutorials under Zensical.

**Decision:** Keep Jupyter’s committed-markdown pipeline. For marimo, sources live in `docs/examples/marimo/*.py` and are exported with `marimo-md-export` via `dev/render_marimo_notebooks.py`; commit the generated `.md`. No Pyodide / live Python in the site.
**Decision (final):** **Do not ship marimo pages in the Zensical docs for now.**
The sample “Hello cellpy (marimo)” page and `dev/render_marimo_notebooks.py`
pipeline were removed. Keep Jupyter’s committed-markdown path.

**Alternatives considered:** Native Zensical marimo plugin (none yet); generate-at-RTD instead of committing (rejected for this spike — match Jupyter); convert existing `.ipynb` set (out of scope).
**Why withdrawn:** `marimo-md-export` flattens `mo.ui.table` to plain Markdown.
Plotly inline scripts break under Material instant navigation. Reactive marimo
islands / Pyodide hang in the docs embed. Client-side stand-ins (Tabulator,
Plotly iframes) work but are no longer “marimo”.

**Ops:** `uv run --group docs python dev/render_marimo_notebooks.py` then `zensical build`. Keep figures light (base64 size). Ignore `__marimo__/` session dirs.
**Revisit when:** Zensical (or a host plugin) supports marimo islands cleanly,
or marimo ships a reliable Python-free static reactive export that fits docs.

**Landing:** Docs-only PRs (including this spike) target the long-lived
`v2-docs-stable` branch; merge that into `master` when ready to publish.
**Landing:** docs work continues on `v2-docs-stable`.
4 changes: 3 additions & 1 deletion HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## [Unreleased]

* Include marimo notebooks in the docs (sample under `docs/examples/marimo/`, `marimo-md-export` render path). (#724).
* Tried shipping marimo notebooks in the docs (#724); withdrawn — Zensical
embeds could not keep a real marimo table/plot experience without hanging
Pyodide or replacing widgets with non-marimo UI.

* Clarify Neware docs: binary `.nda`/`.ndax` via `neware_nda` (bundled fastnda) vs exported `neware_txt` models.

Expand Down
69 changes: 0 additions & 69 deletions dev/render_marimo_notebooks.py

This file was deleted.

17 changes: 0 additions & 17 deletions docs/contributing/developers_guide/dev_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,23 +90,6 @@ The `.ipynb` files stay in the tree as the interactive source.
It renders the outputs already stored in the notebooks; it does **not** execute
them.

### Example notebooks (marimo)

Marimo sources live under `docs/examples/marimo/` (``.py`` notebooks). Zensical
does not execute them either; export to committed markdown with
[`marimo-md-export`](https://jmarshrossney.github.io/marimo-md-export/):

```shell
uv run --group docs python dev/render_marimo_notebooks.py
```

Unlike the Jupyter path, this **does** run the notebooks (via `marimo export`),
so cellpy must be importable. Keep figures light — the exporter embeds images
as base64 and large plotly-style blobs bloat the committed pages. Prefer
matplotlib (or `# @suppress` on heavy cells). No Pyodide / live Python in the
docs site; readers who want to edit interactively should open the ``.py`` with
`marimo edit`.

### Doc-strings

- Use Google-style doc-strings
Expand Down
11 changes: 0 additions & 11 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ folder](https://github.com/jepegit/cellpy/tree/master/examples) in the cellpy Gi
- [GITT](05_GITT.md)
- [Batch processing](batch_utility/cellpy_batch_processing_docs.md)
- [Templates](templates/tutorial_templates.md)
- [Hello cellpy (marimo)](marimo/01_hello_cellpy.md)

## About these pages

Expand All @@ -38,13 +37,3 @@ To re-render after changing a Jupyter notebook:
```shell
uv run --group docs python dev/render_example_notebooks.py
```

There is also a small [marimo](https://marimo.io) spike under
[`docs/examples/marimo/`](https://github.com/jepegit/cellpy/tree/master/docs/examples/marimo).
Those pages are exported with
[`marimo-md-export`](https://jmarshrossney.github.io/marimo-md-export/) (markdown
plus embedded outputs — no Pyodide in the docs site). Re-render with:

```shell
uv run --group docs python dev/render_marimo_notebooks.py
```
55 changes: 0 additions & 55 deletions docs/examples/marimo/01_hello_cellpy.md

This file was deleted.

68 changes: 0 additions & 68 deletions docs/examples/marimo/01_hello_cellpy.py

This file was deleted.

2 changes: 0 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,6 @@ dev = [
]
docs = [
"ipykernel>=7.3.0",
"marimo>=0.23.15",
"marimo-md-export>=0.8.0",
"matplotlib>=3.10.6",
"mkdocstrings-python>=2.0.5",
"nbconvert>=7.17.1",
Expand Down
Loading
Loading