diff options
| -rw-r--r-- | .Rbuildignore | 4 | ||||
| -rw-r--r-- | .github/.gitignore | 1 | ||||
| -rw-r--r-- | .github/workflows/pkgdown.yaml | 50 | ||||
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | DESCRIPTION | 2 | ||||
| -rw-r--r-- | _pkgdown.yml | 3 |
6 files changed, 62 insertions, 1 deletions
diff --git a/.Rbuildignore b/.Rbuildignore index 6128489..0d5f2c3 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,6 +1,10 @@ ^\.git$ ^\.gitattributes$ ^\.gitignore$ +^\.github$ ^CITATION\.cff$ ^LICENSE$ ^README\.Rmd$ +^docs$ +^pkgdown$ +^_pkgdown\.yml$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html 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 @@ -5,3 +5,6 @@ inst/doc vignettes/*.html vignettes/*.R + +docs +pkgdown diff --git a/DESCRIPTION b/DESCRIPTION index 774891e..80b5a27 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,7 +11,7 @@ Description: A collection of methods for estimating the basic reproduction number (R0) of infectious diseases. Optionally available as a web application using the 'shiny' framework. License: AGPL (>= 3) -URL: https://github.com/MI2YorkU/Rnaught +URL: https://MI2YorkU.github.io/Rnaught, https://github.com/MI2YorkU/Rnaught BugReports: https://github.com/MI2YorkU/Rnaught/issues Imports: stats, diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..57aae6b --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,3 @@ +url: https://MI2YorkU.github.io/Rnaught +template: + bootstrap: 5 |