From 5662e90705b1af94ca3efcb49bac557f170d12c0 Mon Sep 17 00:00:00 2001
From: Rucknium <Rucknium@protonmail.com>
Date: Mon, 18 Nov 2024 16:37:38 +0000
Subject: [PATCH] Preparing pkgdown docs website

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

diff --git a/.Rbuildignore b/.Rbuildignore
index 303860a..9b59baa 100644
--- a/.Rbuildignore
+++ b/.Rbuildignore
@@ -3,3 +3,6 @@
 ^\.github$
 ^README.md
 ^LICENSE\.md$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
new file mode 100644
index 0000000..bfc9f4d
--- /dev/null
+++ b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,49 @@
+# 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:
+  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 7e88691..fe55d09 100644
--- a/.gitignore
+++ b/.gitignore
@@ -57,3 +57,4 @@ po/*~
 # RStudio Connect folder
 rsconnect/
 
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
index dea8991..11a9dd4 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -37,3 +37,4 @@ Suggests:
 Config/testthat/edition: 3
 RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
+URL: https://rucknium.github.io/xmrpeers/
diff --git a/_pkgdown.yml b/_pkgdown.yml
new file mode 100644
index 0000000..d71acfb
--- /dev/null
+++ b/_pkgdown.yml
@@ -0,0 +1,4 @@
+url: ~
+template:
+  bootstrap: 5
+