You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sedona.apache.org by pa...@apache.org on 2026/09/22 20:17:01 UTC

(sedona-db) branch main updated: docs(r): publish pkgdown site with documentation (#1332)

This is an automated email from the ASF dual-hosted git repository.

paleolimbot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-db.git


The following commit(s) were added to refs/heads/main by this push:
     new 055171522 docs(r): publish pkgdown site with documentation (#1332)
055171522 is described below

commit 055171522d2d69715269de5e8b136e29c65a119a
Author: Dewey Dunnington <de...@dunnington.ca>
AuthorDate: Tue Sep 22 20:16:55 2026 +0000

    docs(r): publish pkgdown site with documentation (#1332)
---
 .github/workflows/packaging.yml | 10 ++++++++++
 .gitignore                      |  1 +
 ci/scripts/build-docs.sh        | 20 ++++++++++++++++----
 mkdocs.yml                      |  1 +
 4 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml
index 00de63ce7..4f9f11163 100644
--- a/.github/workflows/packaging.yml
+++ b/.github/workflows/packaging.yml
@@ -103,6 +103,10 @@ jobs:
         with:
           python-version: "3.x"
 
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
       - uses: quarto-dev/quarto-actions/setup@v2
 
       - name: Clone vcpkg
@@ -157,6 +161,12 @@ jobs:
         run: |
             pip install -r docs/requirements.txt
 
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown
+          needs: website
+          working-directory: r/sedonadb
+
       - name: Install dev SedonaDB Python
         env:
           MATURIN_PEP517_ARGS: "--features s2geography,pyo3/extension-module"
diff --git a/.gitignore b/.gitignore
index 606212086..2d0ff2751 100644
--- a/.gitignore
+++ b/.gitignore
@@ -40,6 +40,7 @@ coverage/
 
 # documentation
 site/
+docs/r/
 
 # Python cache files
 __pycache__
diff --git a/ci/scripts/build-docs.sh b/ci/scripts/build-docs.sh
index a2d972ae4..e062e3a28 100755
--- a/ci/scripts/build-docs.sh
+++ b/ci/scripts/build-docs.sh
@@ -55,10 +55,22 @@ fi
 popd
 
 pushd "${SEDONADB_DIR}"
-if mkdocs build --strict ; then
-  echo "Success!"
-  exit 0
-else
+
+# Install the R package from source
+R CMD INSTALL r/sedonadb --preclean
+
+# Build R documentation inside the MkDocs source directory so both the MkDocs
+# build and the mike deployment include it. pkgdown paths are relative to the
+# package root (r/sedonadb).
+rm -rf docs/r
+if ! Rscript -e 'pkgdown::build_site("r/sedonadb", override = list(destination = "../../docs/r"), new_process = FALSE, install = FALSE)'; then
+  echo "R documentation build failed"
+  exit 1
+fi
+
+if ! mkdocs build --strict ; then
   echo "Documentation build failed"
   exit 1
 fi
+
+echo "Success!"
diff --git a/mkdocs.yml b/mkdocs.yml
index 7addb612d..a67c64deb 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -42,6 +42,7 @@ nav:
         - GPU Acceleration: gpu-acceleration.md
       - API:
         - Python: reference/python.md
+        - R: r/index.html
         - Zarr Extension (Python): reference/python-zarr.md
         - SQL: reference/sql/index.md
         - Spatial Joins: reference/sql-joins.md