Set up pkgdown

.Rbuildignore

@@ -3,3 +3,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^\.github$

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,50 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -6,3 +6,4 @@
 *.DS_Store
 StabMap.BiocCheck
 .Rproj.user
+docs

DESCRIPTION

@@ -18,7 +18,7 @@ Description: StabMap performs single cell mosaic data integration by first
     given reference and query cell lists.
 License: GPL-2
 Encoding: UTF-8
-URL: https://sydneybiox.github.io/StabMap
+URL: https://sydneybiox.github.io/StabMap, https://sydneybiox.github.io/StabMap/
 BugReports: https://github.com/sydneybiox/StabMap/issues
 biocViews: SingleCell, DimensionReduction, Software
 Depends: R (>= 4.4.0),

_pkgdown.yml

@@ -0,0 +1,9 @@
+url: https://sydneybiox.github.io/StabMap/
+template:
+  bootstrap: 5
+  bootswatch: cosmo
+toc:
+  depth: 3
+navbar:
+  title: ~
+  bg: dark