Deploy docs (#37)

* deploy docs

* fix Documenter.yml

* fix Documenter.yml

* fix docs/Project.toml

* add plot of bathymetry

* add *.png back to .gitignore

.github/workflows/Documenter.yml

@@ -6,14 +6,13 @@ on:
       - 'main'
     tags: '*'
     paths-ignore:
-      - '.zenodo.json'
-      - '.github/workflows/ci.yml'
+      - '.github/workflows/CI.yml'
       - '.github/workflows/CompatHelper.yml'
       - '.github/workflows/TagBot.yml'
   pull_request:
     paths-ignore:
       - '.zenodo.json'
-      - '.github/workflows/ci.yml'
+      - '.github/workflows/CI.yml'
       - '.github/workflows/CompatHelper.yml'
       - '.github/workflows/TagBot.yml'
   workflow_dispatch:
@@ -31,23 +30,16 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
-          version: '1'
+          version: '1.9'
           show-versioninfo: true
       - uses: julia-actions/julia-buildpkg@v1
         env:
           PYTHON: ""
       - name: Install dependencies
         run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
-      #- name: Build and deploy
-      #  uses: julia-actions/julia-docdeploy@v1
-      #  env:
-      #    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      #    DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-      #    GKSwstype: 100 # To make GitHub Action work, disable showing a plot window with the GR backend of the Plots package
-      - name: Run doctests
-        run: |
-          julia --project=docs --color=yes -e '
-            using Documenter: DocMeta, doctest
-            using DispersiveShallowWater
-            DocMeta.setdocmeta!(DispersiveShallowWater, :DocTestSetup, :(using DispersiveShallowWater); recursive=true)
-            doctest(DispersiveShallowWater)' 
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+          GKSwstype: 100 # To make GitHub Action work, disable showing a plot window with the GR backend of the Plots package
+        run: julia --project=docs --color=yes docs/make.jl

docs/Project.toml

@@ -1,8 +1,11 @@
 [deps]
-DispersiveShallowWater = "4ab875f6-b79a-4e28-9745-4f0293954817"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240"
 
 [compat]
 Documenter = "0.27"
 OrdinaryDiffEq = "6.49.1"
+Plots = "1.9"
+SummationByPartsOperators = "0.5.41"