ENH: Add jupyterlite configuration

Author: thewtex

docs/conf.py

@@ -13,7 +13,13 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+from pathlib import Path
+from sphinx.application import Sphinx
+import subprocess
+import os
+import json
 
+RTD = json.loads(os.environ.get("READTHEDOCS", "False").lower())
 
 # -- Project information -----------------------------------------------------
 
@@ -30,7 +36,16 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['myst_parser']
+extensions = ['myst_parser',]
+
+here = Path(__file__).parent.resolve()
+jupyterlite_config = here / "jupyterlite_config.json"
+
+html_theme_options = dict(
+    github_url='https://github.com/InsightSoftwareConsortium/itkwidgets'
+)
+
+# jupyterlite_config = jupyterlite_dir / "jupyterlite_config.json"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -51,4 +66,15 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static',
+        '_output']
+
+def jupyterlite_build(app: Sphinx, error):
+    subprocess.check_call(['jupyter', 'lite', 'build', '--config',
+        str(jupyterlite_config)], cwd=str(here))
+
+def setup(app):
+    # For local builds, run jupyter lite build manually
+    # $ jupyter lite serve --config ./jupyterlite_config.json
+    if RTD:
+        app.connect("config-inited", jupyterlite_build)

docs/images/Hello3DWorld.gif

@@ -10,6 +10,14 @@ powered by [itk-wasm](https://wasm.itk.org) and [ImJoy](https://imjoy.io/).
 *Welcome to The Future* 🔬🚀🛸!
 ```
 
+<a href="./_static/retro/notebooks/?path=Hello3DWorld.ipynb">
+Try it with JupyterLite!
+
+![Jupyterlite](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)
+
+![Hello3DWorld](./images/Hello3DWorld.gif)
+</a>
+
 ```{toctree}
 quick_start_guide.rst
 deployments.rst

docs/index.md

@@ -0,0 +1,14 @@
+{
+    "LiteBuildConfig": {
+        "federated_extensions": [
+            "https://files.pythonhosted.org/packages/15/ef/d7553d9968f317d02ee3e7819be5c9fc6cfa48e9fb3cf0cf92043c6a4205/imjoy_jupyterlab_extension-0.1.13-py3-none-any.whl"
+        ],
+        "ignore_sys_prefix": true,
+        "piplite_urls": [
+            "https://files.pythonhosted.org/packages/14/f7/ea85b5e4f59db353340543d450cd3d1c5befcde8bee0cc41a9de78fed82f/itkwasm-1.0b1-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/e5/e7/3df714a23e165e1097825a6f53c18c3d1c7850de58b5c4ffe6c5a15518bf/imjoy_rpc-0.5.13-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/69/d9/5a6c8af2f4b4f49a809ae316ae4c12937d7dfda4e5b2f9e4167df5f15c0e/imjoy_utils-0.1.2-py3-none-any.whl",
+            "https://files.pythonhosted.org/packages/d1/2c/b2ac53f14e28a2c84446f84b6463561b0b66c839f2f7f2b723264a6a03ec/itkwidgets-1.0a5-py3-none-any.whl"
+        ]
+    }
+}

docs/jupyterlite_config.json

@@ -1,2 +1,3 @@
 pydata-sphinx-theme
 myst-parser
+jupyterlite[all]