build: use nox for tests and docs

.gitignore

@@ -19,6 +19,9 @@ ipyvuetify/labextension/
 ipyvuetify/nbextension/
 js/lib
 
+# Unit test / coverage reports
+.nox
+
 # Sphinx documentation
 docs/_build/
 

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# build with latest available ubuntu version
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+    nodejs: "16"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

docs/conf.py

@@ -30,7 +30,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["jupyter_sphinx.execute", "sphinx_rtd_theme"]
+extensions = ["jupyter_sphinx", "sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

noxfile.py

@@ -0,0 +1,22 @@
+"""
+All the process that can be run using nox.
+
+The nox run are build in isolated environment that will be stored in .nox. to force the venv update, remove the .nox/xxx folder.
+"""
+
+import nox
+
+
+@nox.session(reuse_venv=True)
+def lint(session):
+    """Apply the pre-commits."""
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "-a", *session.posargs)
+
+
+@nox.session(reuse_venv=True)
+def docs(session):
+    """Build the documentation."""
+    session.install("jupyter-packaging", "jupyterlab")
+    session.install(".[doc]")
+    session.run("sphinx-build", "-v", "-b", "html", "docs", "docs/_build/html")

pyproject.toml

@@ -41,7 +41,7 @@ content-type = "text/markdown"
 [project.optional-dependencies]
 dev = ["nox", "pre-commit", "mypy"]
 test = ["pytest", "pytest-playwright", "jupyterlab<4", "solara[pytest]"]
-doc = ["sphinx"]
+doc = ["sphinx<7", "jupyter-sphinx", "ipykernel"]
 
 [tool.setuptools]
 include-package-data = true