update

Remi-Gau · Remi-Gau · commit ea994020ad6b · 2025-04-09T14:43:01.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -14,23 +14,12 @@ __pycache__
 .vscode/
 
 # build related
-build
-dist/
-_version.py
 _site
+notebooks.egg-info
 
 # notebooks
 .ipynb_checkpoints
 
 # virtual environment
 env/
 venv/
-
-# testing
-.pytest_cache
-
-# coverage
-.coverage
-coverage
-coverage.xml
-nosetests_coverage/
diff --git a/README.md b/README.md
@@ -2,3 +2,20 @@
 
 The structure of this repository is mostly adapted from
 the [marimo template repo](https://github.com/marimo-team/marimo-gh-pages-template).
+
+## 🧪 Testing
+
+To test the export process, run `scripts/build.py` from the root directory.
+
+```bash
+tox run -e build
+```
+
+This will export all notebooks in a folder called `_site/` in the root directory.
+Then to serve the site, run:
+
+```bash
+python -m http.server -d _site
+```
+
+This will serve the site at `http://localhost:8000`.
diff --git a/scripts/build.py b/scripts/build.py
@@ -59,9 +59,12 @@ def generate_index(all_notebooks: list[str], output_dir: str) -> None:
     <link href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.19/dist/tailwind.min.css" rel="stylesheet">
   </head>
   <body class="font-sans max-w-2xl mx-auto p-8 leading-relaxed">
-    <div class="mb-8">
-      <img src="https://raw.githubusercontent.com/marimo-team/marimo/main/docs/_static/marimo-logotype-thick.svg" alt="marimo" class="h-20" />
-    </div>
+  <div class="mb-8 flex">
+    <img src="https://raw.githubusercontent.com/marimo-team/marimo/main/docs/_static/marimo-logotype-thick.svg"
+      alt="marimo" class="h-20 flex-1" />
+    <img src="https://raw.githubusercontent.com/nilearn/nilearn/refs/heads/main/doc/logos/nilearn-logo.svg"
+      alt="marimo" class="h-20 flex-1" />
+  </div>
     <div class="grid gap-4">
 """
             )
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,41 @@
+;  See https://tox.wiki/en/4.23.2/
+[tox]
+requires =
+    tox>=4
+; run lint by default when just calling "tox"
+env_list = lint
+
+; ENVIRONMENTS
+; ------------
+[style]
+description = common environment for style checkers (rely on pre-commit hooks)
+skip_install = true
+deps =
+    pre-commit
+
+[global_var]
+passenv =
+    USERNAME
+    # Pass user color preferences through
+    PY_COLORS
+    FORCE_COLOR
+    NO_COLOR
+    CLICOLOR
+    CLICOLOR_FORCE
+
+; COMMANDS
+; --------
+[testenv:lint]
+description = Run all linters and formatters.
+skip_install = true
+commands =
+	pre-commit run --all-files --show-diff-on-failure {posargs:}
+
+[testenv:build]
+description = Run tests on latest version of all dependencies.
+passenv = {[global_var]passenv}
+deps =
+    marimo
+commands =
+    python scripts/build.py
+
