add documentation build and deploy job (#15)

solves: #10

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

docs/make.jl

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