From 86ed97bd21423fdac6f3896f86b1e8e6a73732a8 Mon Sep 17 00:00:00 2001
From: geryan <geryan@users.noreply.github.com>
Date: Fri, 13 Dec 2024 10:42:23 +1100
Subject: [PATCH] use packagedown

---
 .Rbuildignore                  |  3 +++
 .github/workflows/pkgdown.yaml | 49 ++++++++++++++++++++++++++++++++++
 .gitignore                     |  1 +
 DESCRIPTION                    |  4 ++-
 _pkgdown.yml                   |  6 +++++
 5 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml

diff --git a/.Rbuildignore b/.Rbuildignore
index bdeac35..59d02b0 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -6,3 +6,6 @@
 ^codecov\.yml$
 ^data-raw$
 ^further$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..bfc9f4d
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,49 @@
+# 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:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+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/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
index bf66e06..63714e9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@
 *.DS_Store
 *.tif
 *further/
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
index 0bab59c..127d0b5 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -4,7 +4,7 @@ Version: 0.0.0.9000
 Authors@R: c(
     person("Gerry", "Ryan", , "gerard.ryan@telethonkids.org.au", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-0183-7630")),
-    person("Daniel", "Weiss", role = "aut")
+    person("Daniel", "Weiss", role = "aut", comment = c("0000-0002-6175-5648"))
   )
 Description: Calculate travel time over a friction surface from a specified set of locations.
 License: MIT + file LICENSE
@@ -22,3 +22,5 @@ Config/testthat/edition: 3
 Depends: 
     R (>= 3.5)
 LazyData: true
+URL: https://idem-lab.github.io/traveltime/
+BugReports: https://github.com/idem-lab/traveltime/issues
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..4222f23
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,6 @@
+url: https://idem-lab.github.io/traveltime/
+template:
+  bootstrap: 5
+  bootswatch: litera
+
+