Merge pull request #35 from inbo/documentation-website

Documentation website

.Rbuildignore

@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/workflows/pkgdown.yaml

@@ -0,0 +1,48 @@
+# 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
+
+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

.gitignore

@@ -4,3 +4,4 @@
 .httr-oauth
 .DS_Store
 .quarto
+docs

DESCRIPTION

@@ -2,18 +2,14 @@ Package: iassetR
 Title: Use the iAsset API in R
 Version: 0.0.0.9000
 Authors@R: c(
-    person("Pieter", "Huybrechts", email = "[email protected]",
-            role = c("aut", "cre"),
-            comment = c(ORCID = "0000-0002-6658-6062")),
-    person("Sander", "Devisscher", email = "[email protected]",
-            role = c("aut"),
-            comment = c(ORCID = "0000-0003-2015-5731"))
-            )
+    person("Pieter", "Huybrechts", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0002-6658-6062")),
+    person("Sander", "Devisscher", , "[email protected]", role = "aut",
+           comment = c(ORCID = "0000-0003-2015-5731"))
+  )
 Description: This package is an interface to the REST api of iAsset.
 License: MIT + file LICENSE
-Encoding: UTF-8
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+URL: https://inbo.github.io/iassetR/
 Imports: 
     askpass,
     assertthat,
@@ -26,3 +22,6 @@ Imports:
     purrr,
     rlang,
     stringr
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.2.3

_pkgdown.yml

@@ -0,0 +1,4 @@
+url: https://inbo.github.io/iassetR/
+template:
+  bootstrap: 5
+