Update documentation build script

.github/workflows/doc_cleanup.yml

@@ -0,0 +1,24 @@
+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@v3
+        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 "[email protected]"
+              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

@@ -11,14 +11,14 @@ jobs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: julia-actions/setup-julia@latest
         with:
           version: '1'
       - name: Install Dependencies
-        run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        run: julia --project=docs --color=yes -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
       - name: Build and Deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-        run: julia --project=docs docs/make.jl
+        run: julia --project=docs --color=yes docs/make.jl

docs/Project.toml

@@ -1,2 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+WaterModels = "7c60b362-08f4-5b14-8680-cd67a3e18348"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -1,34 +1,41 @@
-using Documenter, WaterModels
+import Documenter
+import WaterModels
 
-makedocs(
-    modules = [WaterModels],
-    format = Documenter.HTML(analytics="UA-367975-10", mathengine=Documenter.MathJax(), prettyurls=false),
+Documenter.makedocs(
     sitename = "WaterModels",
     authors = "Byron Tasseff and contributors",
+    format = Documenter.HTML(
+        analytics="UA-367975-10",
+        mathengine = Documenter.MathJax(),
+        prettyurls = false,
+    ),
     pages = [
         "Home" => "index.md",
         "Manual" => [
             "Getting Started" => "quickguide.md",
             "Network Data Format" => "network-data.md",
             "Result Data Format" => "result-data.md",
-            "Mathematical Models" => "math-model.md"
+            "Mathematical Models" => "math-model.md",
         ],
         "Library" => [
             "Network Formulations" => "formulations.md",
             "Problem Specifications" => "specifications.md",
             "Modeling Components" => [
                 "Objective" => "objective.md",
                 "Variables" => "variables.md",
-                "Constraints" => "constraints.md"
+                "Constraints" => "constraints.md",
             ],
-            "File I/O" => "parser.md"
+            "File I/O" => "parser.md",
         ],
         "Developer" => "developer.md",
-        "Examples" => "examples.md"
+        "Examples" => "examples.md",
     ],
-    warnonly = true
+    clean = true,
+    modules = [WaterModels],
+    warnonly = true,
 )
 
-deploydocs(
+Documenter.deploydocs(
     repo = "github.com/lanl-ansi/WaterModels.jl.git",
+    push_preview = true,
 )