From aecb07f0a4af8dfa473809dae52c2284919e32be Mon Sep 17 00:00:00 2001
From: pvictor <victor.perrier@dreamRs.fr>
Date: Wed, 25 Sep 2024 09:54:52 +0200
Subject: [PATCH] use pkgdown

---
 .Rbuildignore                  |  3 ++
 .github/workflows/pkgdown.yaml | 50 ++++++++++++++++++++++++++++++++++
 .gitignore                     |  1 +
 DESCRIPTION                    |  1 +
 _pkgdown.yml                   |  4 +++
 5 files changed, 59 insertions(+)
 create mode 100644 .github/workflows/pkgdown.yaml
 create mode 100644 _pkgdown.yml

diff --git a/.Rbuildignore b/.Rbuildignore
index 2a13c11..3205f23 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -11,3 +11,6 @@
 ^examples$
 ^data-raw$
 ^\.github$
+^_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 05b9406..dc5f8ba 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,4 @@
 node_modules
 *.Rproj
 inst/doc
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
index ef8b5b9..e5435af 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -29,3 +29,4 @@ VignetteBuilder: knitr
 Depends: 
     R (>= 2.10)
 LazyData: true
+URL: https://dreamrs.github.io/vchartr/
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..9c93269
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: https://dreamrs.github.io/vchartr/
+template:
+  bootstrap: 5
+