add Github Action to build and deploy documentation

.github/workflows/BuildDelopyDoc.yml

@@ -0,0 +1,31 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.9'
+      - name: Add custom registry 
+        run: |
+          julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry.git"));'
+          julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"));'
+      - 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
+        run: julia --project=docs/ docs/make.jl

README.md

@@ -1,7 +1,7 @@
 # QED
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://szabo137.github.io/QED.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://szabo137.github.io/QED.jl/dev/)
+[![Doc Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://qedjl-project.github.io/QED.jl/main)
+[![Doc Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://qedjl-project.github.io/QED.jl/dev)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
 ## Installation

docs/make.jl

@@ -6,15 +6,15 @@ DocMeta.setdocmeta!(QED, :DocTestSetup, :(using QED); recursive=true)
 makedocs(;
     modules=[QED],
     authors="Uwe Hernandez Acosta <[email protected]>, Simeon Ehrig, Klaus Steiniger, Tom Jungnickel, Anton Reinhard",
-    repo="https://www.github.com/szabo137/QED.jl/blob/{commit}{path}#{line}",
+    repo=Documenter.Remotes.GitHub("QEDjl-project", "QED.jl"),
     sitename="QED.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://szabo137.github.io/QED.jl",
-        edit_link="main",
+        canonical="https://qedjl-project.github.io/QED.jl/",
+        edit_link="dev",
         assets=String[],
     ),
     pages=["Home" => "index.md", "Automatic Testing" => "ci.md"],
 )
 
-deploydocs(; repo="www.github.com/szabo137/QED.jl", devbranch="main")
+deploydocs(; repo="github.com/QEDjl-project/QED.jl.git", push_preview=false)