[docs] Upgrade to Documenter v1 (#1313)

* [docs] Upgrade to Documenter v1

* [CI] Add workflow to cleanup previews

* [CI] Fix version of `julia-actions/julia-docdeploy` workflow

Author: giordano

.github/workflows/PreviewCleanup.yml

@@ -0,0 +1,26 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "previews/PR$PRNUM"
+              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
+        env:
+            PRNUM: ${{ github.event.number }}

.github/workflows/documentation.yml

@@ -28,6 +28,6 @@ jobs:
           Pkg.Registry.update()
           Pkg.develop(PackageSpec(path=pwd()))
           Pkg.instantiate()
-      - uses: julia-actions/julia-docdeploy@releases/v1
+      - uses: julia-actions/julia-docdeploy@v1
         env:
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

docs/Project.toml

@@ -3,4 +3,4 @@ BinaryBuilderBase = "7f725544-6523-48cd-82d1-3fa08ff4056e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"

docs/make.jl

@@ -17,7 +17,6 @@ makedocs(
             "Reference" => "reference.md",
         ],
     ],
-    strict = true,
 )
 
 deploydocs(