Deploy previews on RTD, main to GitHub Pages (#21)

* Deploy previews on RTD

* add kernel

* fix typo

* add github pages build

Author: jtpio

.github/workflows/build.yml

@@ -2,9 +2,9 @@ name: Build
 
 on:
   push:
-    branches: main
+    branches: [main]
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -54,6 +54,47 @@ jobs:
         path: dist/jupyterlab_hybrid_kernels*
         if-no-files-found: error
 
+  build_lite:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - uses: actions/download-artifact@v4
+        with:
+          name: extension-artifacts
+      - name: Install the dependencies
+        run: |
+          python -m pip install --pre jupyterlite-core jupyterlite-pyodide-kernel jupyterlab_hybrid_kernels*.whl
+      - name: Build the JupyterLite site
+        run: |
+          jupyter lite build --output-dir dist
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+  deploy_lite:
+    needs: build_lite
+    if: github.ref == 'refs/heads/main'
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
   test_isolated:
     needs: build
     runs-on: ubuntu-latest

.github/workflows/rtd-preview.yml

@@ -0,0 +1,24 @@
+name: RTD Preview
+on:
+  pull_request_target:
+    types: [opened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  binder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment on the PR with the RTD preview
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          script: |
+            var PR_NUMBER = context.issue.number
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlab-hybrid-kernels--${PR_NUMBER}.org.readthedocs.build/en/${PR_NUMBER}) :point_left: Try it on ReadTheDocs`
+            })

.gitignore

@@ -126,3 +126,7 @@ dmypy.json
 
 # Jupyter Notebooks
 [Uu]ntitled*
+
+# JupyterLite
+.jupyterlite.doit.db
+_output/

.readthedocs.yml

@@ -0,0 +1,12 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-latest
+  commands:
+    - mamba env update --name base --file docs/environment.yml
+    - python -m pip install .
+    - jupyter lite build --output-dir dist
+    - mkdir -p $READTHEDOCS_OUTPUT/html
+    - cp -r dist/* $READTHEDOCS_OUTPUT/html/

docs/environment.yml

@@ -0,0 +1,11 @@
+name: jupyterlab-hybrid-kernels
+channels:
+- conda-forge
+dependencies:
+- pip
+- python=3.11
+- ipywidgets>=8.1,<9
+- jupyterlab>=4.5.0,<5
+- nodejs=22
+- jupyterlite-core>=0.7.0,<0.8
+- jupyterlite-pyodide-kernel>=0.7.0,<0.8