[SEDONA-245] R include man pages + use pkgdown for package documentation

.github/workflows/docs.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v2
       with:
@@ -22,23 +22,25 @@ jobs:
     - run: pip install mkdocs-git-revision-date-localized-plugin
     - run: pip install mike
     - run: sudo apt update
-    - run: sudo apt install littler tree libcurl4-openssl-dev
-    - run: (sudo Rscript generate-docs.R)
-
-    - uses: actions/cache@v2
+    - uses: r-lib/actions/setup-r@v2
       with:
-        path: ~/.local/share/renv
-        key: ${{ runner.os }}-renv-${{ hashFiles('**/renv.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-renv-
+        r-version: release
+        use-public-rspm: true
+    - name: Query R dependencies
+      uses: r-lib/actions/setup-r-dependencies@v2
+      with:
+        cache: true
+        extra-packages: |
+          any::pkgdown
+        working-directory : './R'
+    - run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE, override = list(destination = "../docs/api/rdocs"))'
     - uses: actions/cache@v2
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip-
 
-    - run: (cd docs/api/rdocs/; sudo tree -H '.' -L 1 --noreport --charset utf-8 -o index.html)
     - run: git config --global user.name = "test-name"
     - run: git config --global user.email = "test-email@abc.com"
     - run: mike deploy --update-aliases current-snapshot

R/.Rbuildignore

@@ -28,3 +28,5 @@
 ^doc$
 ^Meta$
 ^LICENSE$
+^pkgdown$
+^vignettes/articles$

R/.gitignore

@@ -44,4 +44,5 @@ h2ologs/*
 # RDS file generated by testthat
 tests/testthat/testthat-problems\.rds
 # Generated by roxygen2
-man
+docs
+inst/doc

R/DESCRIPTION

@@ -23,6 +23,8 @@ Maintainer: Apache Sedona <private@sedona.apache.org>
 Description: R interface for 'Apache Sedona' based on 'sparklyr'
     (<https://sedona.apache.org>).
 License: Apache License 2.0
+URL: https://github.com/apache/sedona/, https://sedona.apache.org/
+BugReports: https://github.com/apache/sedona/issues
 Depends:
     R (>= 3.2)
 Imports:
@@ -37,5 +39,5 @@ Suggests:
     rmarkdown
 Encoding: UTF-8
 RoxygenNote: 7.2.3
-SystemRequirements: 'Apache Spark' 2.4.x or 3.x
+SystemRequirements: 'Apache Spark' 3.x
 Roxygen: list(markdown = TRUE)