Merge pull request #3491 from jasongrout/jlite2

Package example notebooks in JupyterLite

.github/workflows/tests.yml

@@ -9,15 +9,21 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: 3.7
-    - uses: actions/cache@v1
+        cache: 'pip'
+        cache-dependency-path: |
+          **/setup.cfg
+          **/requirements*.txt
+    - name: Install node
+      uses: actions/setup-node@v3
       with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        node-version: '14'
+        cache: 'yarn'
+        cache-dependency-path: |
+          yarn.lock
+          ui-tests/yarn.lock
     - name: Install dependencies
       run: |
         sudo apt-get install -y pandoc
@@ -26,24 +32,22 @@ jobs:
         python -m pip install -r ./docs/requirements.txt
     - name: Build docs
       run: |
-        cd docs
-        make html
+        cd docs/source
+        python -m sphinx -T -E -b html -d ../build/doctrees -D language=en . ../build/html
   js:
     name: JavaScript
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: 3.7
-    - uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'pip'
+        cache-dependency-path: |
+          **/setup.cfg
+          **/requirements*.txt
     - name: Install dependencies
       run: |
         sudo apt-get install -y firefox
@@ -93,15 +97,13 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'pip'
+        cache-dependency-path: |
+          **/setup.cfg
+          **/requirements*.txt
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -117,15 +119,13 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: 3.7
-    - uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'pip'
+        cache-dependency-path: |
+          **/setup.cfg
+          **/requirements*.txt
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -141,16 +141,13 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: '3.10'
-    - uses: actions/cache@v1
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/setup.py') }}-${{hashFiles('**/requirements.txt')}}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-
+        cache: 'pip'
+        cache-dependency-path: |
+          **/setup.cfg
+          **/requirements*.txt
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.gitignore

@@ -4,6 +4,9 @@ dist
 _build
 docs/man/*.gz
 docs/source/api/generated
+docs/source/.cache
+*.doit.db
+_contents
 node_modules
 *.py[co]
 __pycache__

.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "mambaforge-4.10"
+python:
+  install:
+    - method: pip
+      path: ./python/ipywidgets
+conda:
+  environment: docs/environment.yml
+
+# python:
+#     version: 3.7
+#     install:
+#       - method: pip
+#         path: ./python/ipywidgets
+#       - requirements: docs/requirements.txt

docs/Readme.md

@@ -0,0 +1,24 @@
+# Building ipywidgets documentation
+
+To build the ipywidgets documentation:
+
+1. Install the development version of ipywidgets with the `dev-install.sh` script in the repo root directory.
+2. Install the Python packages for building documentation with either mamba or conda:
+   ```sh
+   conda update --file docs/environment.yml 
+   ```
+
+   or with `pip`:
+
+   ```sh
+   python -m pip install -r docs/requirements.txt
+   # Also install pandoc separately
+   ```
+
+3. Build the HTML docs with sphinx:
+   ```sh
+   cd docs/source
+   python -m sphinx -T -E -b html -d ../build/doctrees -D language=en . ../build/html
+   ```
+
+4. Open the documentation from the build directory: `docs/build/html`

docs/environment.yml

@@ -0,0 +1,29 @@
+name: docs
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - bqplot
+  - build
+  - empack
+  - ipykernel
+  - jupyter_client
+  - jupyterlab >=3,<4
+  - jupyter-packaging
+  - matplotlib
+  - nbsphinx
+  - nodejs=14
+  - numpy
+  - packaging
+  - pandoc
+  - pip
+  - python=3.10
+  - recommonmark
+  - scikit-image
+  - scikit-learn
+  - sphinx
+  - sphinx_rtd_theme
+  - sympy
+  - pip:
+    - jupyterlite==0.1.0b10
+    - jupyterlite-sphinx>=0.6.0

docs/requirements.txt

@@ -1,6 +1,9 @@
 bqplot
+build
 ipykernel
 jupyter_client
+jupyterlab>=3,<4
+jupyterlite-sphinx
 matplotlib
 nbsphinx>=0.5
 numpy
@@ -10,3 +13,6 @@ sphinx_rtd_theme
 packaging
 scikit-image
 scikit-learn
+sympy
+jupyterlite==0.1.0b10
+jupyterlite-sphinx>=0.6.0