Skip to content

Commit

Permalink
add pkgdown link
Browse files Browse the repository at this point in the history
  • Loading branch information
philchalmers committed Jul 23, 2024
1 parent 1c5b620 commit d4fba33
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@
.Rprofile
Makefile
^\.travis\.yml$
^_pkgdown\.yml$
^docs$
^pkgdown$
^\.github$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
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

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 @@ -4,3 +4,4 @@
inst/doc/*_cache/
inst/doc/*_files/
inst/doc/*.html
docs
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,5 @@ Suggests:
License: GPL (>=2)
ByteCompile: yes
LazyData: true
URL: https://github.com/philchalmers/SimDesign,
https://github.com/philchalmers/SimDesign/wiki
URL: https://github.com/philchalmers/SimDesign, https://github.com/philchalmers/SimDesign/wiki, http://philchalmers.github.io/SimDesign/
RoxygenNote: 7.3.2
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ install:
cd ..;\
R CMD INSTALL $(PKGSRC)

check:
check:
Rscript -e "devtools::check(document = FALSE, args = '--as-cran')"

news:
sed -e 's/^-/ -/' -e 's/^## *//' -e 's/^# //' <NEWS.md | fmt -80 >NEWS

pkgdown:
Rscript -e "pkgdown::build_site()"

test:
Rscript -e "library('testthat',quietly=TRUE);library('SimDesign',quietly=TRUE);options(warn=2);test_dir('tests/tests')"

Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: http://philchalmers.github.io/SimDesign/
template:
bootstrap: 5

0 comments on commit d4fba33

Please sign in to comment.