Build and publish docs to github pages

This also makes use of jupyterlite-sphinx to automatically embed the lite deployment into the docs
geojupyter · Nov 19, 2024 · bd1c29c · bd1c29c
1 parent 456b948
commit bd1c29c
Show file tree

Hide file tree

Showing 16 changed files with 15 additions and 480 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -243,8 +243,8 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
 
-  build-lite:
-    name: Build JupyterLite
+  build-docs-and-lite:
+    name: Build docs with JupyterLite deployment
     needs: build
     runs-on: ubuntu-latest
 
@@ -262,6 +262,10 @@ jobs:
             pip
             jupyterlite-core>=0.2.0,<0.3.0
             jupyterlite-xeus>=0.1.2,<0.2
+            jupyterlite-sphinx
+            sphinx
+            sphinxpydata-sphinx-theme
+            sphinx-autodoc-typehints
 
       - name: Download extension package
         uses: actions/download-artifact@v3
@@ -275,12 +279,11 @@ jobs:
           cp ./jupytergis_core/dist/jupytergis*.whl ./jupytergis_lab/dist/jupytergis*.whl ./jupytergis_qgis/dist/jupytergis*.whl .
           python -m pip install jupytergis*.whl
 
-      - name: Build the lite site
+      - name: Build the docs site
         shell: bash -l {0}
-        working-directory: lite
+        working-directory: docs
         run: |
           set -eux
-          mkdir -p content && cp ../examples/*.jGIS ../examples/*.json ./content
           jupyter lite build --contents content --output-dir dist
 
       - name: Upload artifact
@@ -296,7 +299,7 @@ jobs:
           artifact_link: 'https://github.com/${{ github.repository }}/actions/runs/${{github.run_id}}/artifacts/${{ steps.upload-jupyterlite-artifact.outputs.artifact_id }}'
 
   deploy:
-    needs: build-lite
+    needs: build-docs-and-lite
     if: github.ref == 'refs/heads/main'
     permissions:
       pages: write

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/source/assets/lab_ext.webp → docs/assets/lab_ext.webp b/docs/source/assets/lab_ext.webp → docs/assets/lab_ext.webp
diff --git a/docs/source/collab.rst → docs/collab.rst b/docs/source/collab.rst → docs/collab.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -19,6 +19,9 @@
 author = "The JupyterGIS Development Team"
 language = "en"
 
+jupyterlite_contents = ["../examples/*.jGIS", "../examples/*.json"]
+jupyterlite_dir = "."
+
 exclude_patterns = []
 highlight_language = "python"
 pygments_style = "sphinx"

diff --git a/docs/source/contributing.rst → docs/contributing.rst b/docs/source/contributing.rst → docs/contributing.rst
diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -1,11 +1,6 @@
-name: jupytergis
+name: xeus-python-kernel
 channels:
+  - https://repo.mamba.pm/emscripten-forge
   - conda-forge
 dependencies:
-  - python=3.12
-  - pip
-  - sphinx
-  - pydata-sphinx-theme
-  - sphinx-autodoc-typehints
-  - pip:
-      - jupytergis
+  - xeus-python
diff --git a/docs/source/extension.rst → docs/extension.rst b/docs/source/extension.rst → docs/extension.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/install.rst → docs/install.rst b/docs/source/install.rst → docs/install.rst
diff --git a/lite/jupyter-lite.json → docs/jupyter-lite.json b/lite/jupyter-lite.json → docs/jupyter-lite.json
diff --git a/lite/jupyter_lite_config.json → docs/jupyter_lite_config.json b/lite/jupyter_lite_config.json → docs/jupyter_lite_config.json