add doc

.github/workflows/Documentation.yml

@@ -0,0 +1,25 @@
+# [.github/workflows/Documentation.yml]
+name: Documentation
+
+on:
+ push:
+ branches:
+ - main
+ tags: '*'
+ pull_request:
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - uses: julia-actions/setup-julia@latest
+ - uses: julia-actions/julia-buildpkg@latest
+ - name: Install dependencies
+ run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+ - name: Build and deploy
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+ DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating 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/ -e 'ENV["GKSwstype"]="nul" ; include("docs/make.jl")'