Pkgdown site

.Rbuildignore

@@ -9,3 +9,6 @@ CONTRIBUTING.md
 ^SECURITY\.md$
 azure-pipelines.yml
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$

.github/.gitignore

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

.github/workflows/pkgdown.yaml

@@ -0,0 +1,35 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/master/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master, pkgdown_site]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - 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: Deploy package
+        run: |
+          git config --local user.name "$GITHUB_ACTOR"
+          git config --local user.email "[email protected]"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

.gitignore

@@ -37,3 +37,4 @@ vignettes/*.pdf
 
 # R Environment Variables
 .Renviron
+docs

DESCRIPTION

@@ -36,4 +36,5 @@ Suggests:
     emayili,
     readr
 Roxygen: list(markdown=TRUE, r6=FALSE)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
+Encoding: UTF-8

Microsoft365R.Rproj

@@ -0,0 +1,17 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source

_pkgdown.yml

@@ -0,0 +1,49 @@
+reference:
+- title: Login Clients 
+  desc: Login Clients for Microsoft 365
+- contents:
+  - starts_with('get')
+  - starts_with('list')
+- title: Teams Class Objects
+  desc: R6 Class Objects for Microsoft Teams
+- contents:
+  - ms_team
+  - ms_team_member
+  - ms_channel
+  - ms_chat
+  - ms_chat_message
+- title: OneDrive and SharePoint Class Objects
+  desc: R6 class objects for Microsoft OneDrive and SharePoint
+- contents:
+  - ms_site
+  - ms_drive
+  - ms_drive_item
+  - ms_list
+  - ms_list_item
+- title: Outlook Class Objects
+  desc: R6 class objects for Microsoft Outlook
+- contents:
+  - ms_outlook
+  - ms_outlook_attachment
+  - ms_outlook_email
+  - ms_outlook_folder
+- title: Planner Class Objects
+  desc: R6 class objects for Microsoft Planner
+- contents:
+  - ms_plan
+  - ms_plan_bucket
+  - ms_plan_task
+- title: Deprecated Functions
+  desc: Deprecated functions no longer in use
+- contents:
+  - personal_onedrive
+  - business_onedrive
+  - sharepoint_site
+- title: Accessor Methods
+  desc: Microsoft 365 object accessor methods
+- contents:
+  - add_methods
+- title: Microsoft365r Options
+  desc: Global options for interaction with the underlying Graph API
+- contents:
+  - microsoft365r_options

vignettes/auth.Rmd

@@ -3,7 +3,7 @@ title: "Authenticating to Microsoft 365"
 author: Hong Ooi
 output: rmarkdown::html_vignette
 vignette: >
-    %\VignetteIndexEntry{Authentication}
+    %\VignetteIndexEntry{Authenticating to Microsoft 365}
     %\VignetteEngine{knitr::rmarkdown}
     %\VignetteEncoding{utf8}
 ---

vignettes/scripted.Rmd

@@ -3,7 +3,7 @@ title: "Using Microsoft365R in an unattended script"
 author: Hong Ooi
 output: rmarkdown::html_vignette
 vignette: >
-    %\VignetteIndexEntry{Microsoft365R in an unattended script}
+    %\VignetteIndexEntry{Using Microsoft365R in an unattended script}
     %\VignetteEngine{knitr::rmarkdown}
     %\VignetteEncoding{utf8}
 ---

vignettes/shiny.Rmd

@@ -3,7 +3,7 @@ title: "Using Microsoft365R in a Shiny app"
 author: Hong Ooi
 output: rmarkdown::html_vignette
 vignette: >
-    %\VignetteIndexEntry{Microsoft365R and Shiny}
+    %\VignetteIndexEntry{Using Microsoft365R in a Shiny app}
     %\VignetteEngine{knitr::rmarkdown}
     %\VignetteEncoding{utf8}
 ---