Update Documenter to version 1

.github/dependabot.yml

@@ -0,0 +1,7 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"

.github/workflows/Docs.yml

@@ -9,6 +9,9 @@ on:
 
 jobs:
   docs:
+    permissions:
+      contents: write
+      statuses: write
     name: Documentation
     runs-on: ubuntu-latest
     steps:
@@ -24,4 +27,3 @@ jobs:
       - run: julia --project=docs docs/make.jl
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/DocsPreviewCleanup.yml

@@ -4,23 +4,30 @@ on:
   pull_request:
     types: [closed]
 
+# Ensure that only one "DocsPreviewCleanup" workflow is force pushing at a time
+concurrency:
+  group: docs-preview-cleanup
+  cancel-in-progress: false
+
 jobs:
-  cleanup:
+  docs-preview-cleanup:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Checkout gh-pages branch
         uses: actions/checkout@v2
         with:
           ref: gh-pages
       - name: Delete preview and history + push changes
         run: |
-            if [ -d "previews/PR$PRNUM" ]; then
+          if [ -d "${preview_dir}" ]; then
               git config user.name "Documenter.jl"
               git config user.email "documenter@juliadocs.github.io"
-              git rm -rf "previews/PR$PRNUM"
+              git rm -rf "${preview_dir}"
               git commit -m "delete preview"
               git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
               git push --force origin gh-pages-new:gh-pages
-            fi
+          fi
         env:
-            PRNUM: ${{ github.event.number }}
+          preview_dir: previews/PR${{ github.event.number }}

docs/Project.toml

@@ -8,5 +8,5 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 AbstractGPs = "0.3, 0.4, 0.5"
 AbstractGPsMakie = "0.2"
 CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10"
-Documenter = "0.27"
+Documenter = "1"
 julia = "1.3"

docs/make.jl

@@ -22,7 +22,6 @@ makedocs(;
         assets=String[],
     ),
     pages=["Home" => "index.md", "api.md"],
-    #strict=true,
     checkdocs=:exports,
 )
 

docs/src/api.md

@@ -4,6 +4,7 @@
 
 ```@docs
 symband
+symband!
 ```
 
 ### Example
@@ -27,6 +28,7 @@ save("symband_example.svg", current_figure()); nothing # hide
 
 ```@docs
 gpsample
+gpsample!
 gpsample(::AbstractVector, ::AbstractGPsMakie.AbstractGP)
 ```