Add files for JupyterLite (#118)

* Add files for JupyterLite * Update jupyterlite_contents * use rtd jobs * update author * try without explicit config * add piplite-urls * update config * try with the ipywidgets wheel * install ipylab in notebooks * update README.md * lint
jtpio · Mar 30, 2023 · 2de9db4 · 2de9db4
1 parent 2b86b6e
commit 2de9db4
Show file tree

Hide file tree

Showing 21 changed files with 104 additions and 353 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,5 @@
 node_modules
 dist
+docs
 coverage
 **/*.d.ts
diff --git a/.prettierignore b/.prettierignore
@@ -3,3 +3,4 @@ node_modules
 **/lib
 **/package.json
 ipylab/labextension
+docs
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # ipylab
 
 ![Github Actions Status](https://github.com/jtpio/ipylab/workflows/Build/badge.svg)
+[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://ipylab.readthedocs.io/en/latest/lite/lab)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jtpio/ipylab/main?urlpath=lab/tree/examples/widgets.ipynb)
 [![Conda Version](https://img.shields.io/conda/vn/conda-forge/ipylab.svg)](https://anaconda.org/conda-forge/ipylab)
 [![pypi](https://img.shields.io/pypi/v/ipylab.svg)](https://pypi.python.org/pypi/ipylab)
@@ -22,6 +23,10 @@ Try it in your browser with Binder:
 
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jtpio/ipylab/main?urlpath=lab/tree/examples/widgets.ipynb)
 
+Or with [JupyterLite](https://github.com/jupyterlite/jupyterlite):
+
+[![JupyterLite](https://jupyterlite.rtfd.io/en/latest/_static/badge-launch.svg)](https://ipylab.readthedocs.io/en/latest/lite/lab)
+
 ## Examples
 
 ### Add Jupyter Widgets to the JupyterLab interface

diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,21 @@
+extensions = ["myst_parser", "jupyterlite_sphinx"]
+
+jupyterlite_config = "jupyter_lite_config.json"
+jupyterlite_dir = "."
+jupyterlite_contents = "../examples"
+
+master_doc = "index"
+source_suffix = ".md"
+
+# General information about the project.
+project = "ipylab"
+author = "ipylab contributors"
+
+exclude_patterns = []
+highlight_language = "python"
+pygments_style = "sphinx"
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+
+html_css_files = ["custom.css"]
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -1,11 +1,17 @@
-
-name: ipylab_docs
+name: ipylab-lite
 channels:
-  - conda-forge
+- conda-forge
 dependencies:
-- python=3.9
-- nodejs
-- numpy
-- sphinx
-- nbsphinx
-- jupyter_sphinx
+- build
+- python=3.11
+- mamba
+- pydata-sphinx-theme
+- myst-parser
+- ipywidgets>=8.0,<9
+- jupyterlab>=3.5.0,<4
+- nodejs=18
+- pip:
+  - jupyterlite-sphinx
+  - jupyterlite-core==0.1.0b22
+  - jupyterlite-pyodide-kernel==0.0.5
+  - ..
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,2 @@
+```{include} ../README.md
+```
diff --git a/docs/jupyter_lite_config.json b/docs/jupyter_lite_config.json
@@ -0,0 +1,8 @@
+{
+    "PipliteAddon": {
+        "piplite_urls": [
+          "../dist",
+          "https://files.pythonhosted.org/packages/py3/i/ipywidgets/ipywidgets-8.0.4-py3-none-any.whl"
+        ]
+      }
+}
diff --git a/docs/source/_static/helper.js b/docs/source/_static/helper.js
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/develop-install.rst b/docs/source/develop-install.rst
diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
diff --git a/docs/source/examples/introduction.nblink b/docs/source/examples/introduction.nblink
diff --git a/docs/source/index.rst b/docs/source/index.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ node_modules @@
     **/lib
     **/package.json
     ipylab/labextension
+    docs