Create website

.Rbuildignore

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

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.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

@@ -17,3 +17,4 @@ Imports:
     httr2,
     jsonlite,
     tibble
+URL: https://hauselin.github.io/ollamar/

NAMESPACE

@@ -1,7 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(chat)
-export(create_request)
 export(delete)
 export(embeddings)
 export(generate)

R/ollama.R

@@ -7,15 +7,13 @@ package_config <- list(
 )
 
 
-#' Create a httr2 request object
+#' Create a httr2 request object.
+#'
+#' Creates a httr2 request object with the base URL, headers and endpoint. Used by other functions in the package and not intended to be used directly.
 #'
 #' @param endpoint The endpoint to create the request
 #'
 #' @return A httr2 request object.
-#' @export
-#'
-#' @examples
-#' create_request("/api/tags")
 create_request <- function(endpoint) {
     url <- package_config$baseurls[1]
     url <- httr2::url_parse(url)

_pkgdown.yml

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