Skip to content

Commit

Permalink
use packagedown
Browse files Browse the repository at this point in the history
  • Loading branch information
geryan committed Dec 12, 2024
1 parent 26384e3 commit 86ed97b
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
^codecov\.yml$
^data-raw$
^further$
^_pkgdown\.yml$
^docs$
^pkgdown$
49 changes: 49 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
*.DS_Store
*.tif
*further/
docs
4 changes: 3 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
6 changes: 6 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
url: https://idem-lab.github.io/traveltime/
template:
bootstrap: 5
bootswatch: litera


0 comments on commit 86ed97b

Please sign in to comment.