add: gh-pages

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# 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
+
+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@v3
+
+      - 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/github-pages-deploy-action@v4.4.1
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

DESCRIPTION

@@ -24,7 +24,8 @@ Description: Data Analysis using Bootstrap-Coupled ESTimation.
   The free-to-view PDF is located at <https://rdcu.be/bHhJ4>.
 License: Apache License (>= 2)
 Encoding: UTF-8
-URL: https://github.com/sunroofgod/dabestr-prototype
+URL: https://github.com/sunroofgod/dabestr-prototype,
+    https://sunroofgod.github.io/dabestr-prototype/
 Depends:
   R (>= 2.10)
 Imports: 
@@ -59,4 +60,3 @@ Suggests:
 Config/testthat/edition: 3
 LazyData: true
 VignetteBuilder: knitr
-

_pkgdown.yml

@@ -1,26 +1,34 @@
-url: ~
+url: https://sunroofgod.github.io/dabestr-prototype/
 template:
   bootstrap: 5
   bslib:
-    primary: "#0054AD"
+    primary: '#0054AD'
     border-radius: 0.5rem
     btn-border-radius: 0.25rem
-
 home:
   sidebar:
-    structure: [links, license, community, citation, authors]
-
+    structure:
+    - links
+    - license
+    - community
+    - citation
+    - authors
 navbar:
   structure:
-    left: [intro, reference, articles, tutorials, news]
-    right: [search, github]
-
+    left:
+    - intro
+    - reference
+    - articles
+    - tutorials
+    - news
+    right:
+    - search
+    - github
 articles:
 - title: Misc
-  navbar:
-  contents:
-  - plot_aesthetics
-- title: Tutorials 
+  navbar: ~
+  contents: plot_aesthetics
+- title: Tutorials
   navbar: Tutorials
   contents:
   - tutorial_basics
@@ -29,29 +37,31 @@ articles:
   - tutorial_minimeta
   - tutorial_deltadelta
   - datasets
-
 reference:
-- subtitle: Main API 
-  desc: >
-    Functions responsible for producing an estimation plot. They have been 
-    sequentially organised for their intended procedural utilisation. 
-- contents: 
+- subtitle: Main API
+  desc: "Functions responsible for producing an estimation plot. They have been  sequentially
+    organised for their intended procedural utilisation. \n"
+- contents:
   - load
   - effect_size
   - dabest_plot
-
 - subtitle: Adjusting plot aesthetics
-- contents:
-  - plot_kwargs
-
+- contents: plot_kwargs
 authors:
   Kah Seng Lian:
     href: https://github.com/sunroofgod
   Zhuoyu Wang:
-    href:
+    href: ~
   Jun Yang Liao:
     href: https://github.com/junyangliao
   footer:
-    roles: [cre, aut, ctb]
+    roles:
+    - cre
+    - aut
+    - ctb
   sidebars:
-    roles: [aut, cre, fnd]
+    roles:
+    - aut
+    - cre
+    - fnd
+