diff --git a/.Rbuildignore b/.Rbuildignore index c598aaf..4e10107 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -4,3 +4,6 @@ Read-and-delete-me ^LICENSE\.md$ ^\.github$ ^data-raw$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..4bbce75 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -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/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/.gitignore b/.gitignore index 97f97be..95b38ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .Rproj.user .Rhistory inst/doc +docs diff --git a/DESCRIPTION b/DESCRIPTION index 04b159b..c424461 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -34,3 +34,4 @@ Suggests: ggplot2 Config/testthat/edition: 3 VignetteBuilder: knitr +URL: https://nerc-ceh.github.io/jsdmstan/ diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..19f698a --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,15 @@ +url: https://nerc-ceh.github.io/jsdmstan/ +template: + bootstrap: 5 + bslib: + bg: "#fff" + fg: "#292C2F" + primary: "#0483A4" + secondary: "#EAEFEC" + success: "#37a635" + info: "#34b8c7" + warning: "#F49633" + base_font: {google: "Montserrat"} + heading_font: {google: "Montserrat"} + code_font: {google: "Roboto Mono"} +