Merge pull request #5 from ElianHugh/pkgdown

pkgdown

Author: ElianHugh

.Rbuildignore

@@ -11,3 +11,4 @@
 ^\.lintr$
 ^README\.Rmd$
 ^TODO\.md$
+^docs$

.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
+
+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

.gitignore

@@ -50,3 +50,4 @@ rsconnect/
 
 # debug files
 .fuse_hidden*
+docs

DESCRIPTION

@@ -6,7 +6,7 @@ Authors@R:
            comment = c(ORCID = "0000-0001-8008-3165"))
 Description: Enhances development for plumber APIs by enabling live reloading. Monitors API files for changes and automatically refreshes the server and connected web clients, allowing for faster API iteration.
 License: GPL (>= 3)
-URL: https://github.com/ElianHugh/hotwater
+URL: https://github.com/ElianHugh/hotwater, https://elianhugh.github.io/hotwater/
 BugReports: https://github.com/ElianHugh/hotwater/issues
 Imports:
     cli,

_pkgdown.yml

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