Skip to content

Commit

Permalink
setup pkgdown gh pages
Browse files Browse the repository at this point in the history
  • Loading branch information
jefferis committed Aug 4, 2024
1 parent d77cccc commit 09d906f
Show file tree
Hide file tree
Showing 28 changed files with 56 additions and 3,568 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
^_pkgdown\.yml$
^docs$
^\.github$
^pkgdown$
50 changes: 50 additions & 0 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
@@ -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.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/[email protected]
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 @@ -2,3 +2,4 @@
private/
.Rproj.user
.Rhistory
docs
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ LazyLoad: yes
RoxygenNote: 7.3.2
Language: en-GB
Encoding: UTF-8
URL: https://jefferis.github.io/IgorR/
3 changes: 3 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
url: https://jefferis.github.io/IgorR/
template:
bootstrap: 5
reference:
- title: Package Help
contents:
Expand Down
140 changes: 0 additions & 140 deletions docs/404.html

This file was deleted.

143 changes: 0 additions & 143 deletions docs/authors.html

This file was deleted.

Loading

0 comments on commit 09d906f

Please sign in to comment.