Documentation setup

.github/workflows/docx.yml

@@ -0,0 +1,24 @@
+name: Documenter
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.10'  # Use the appropriate Julia version
+      - name: Install dependencies
+        run: julia --project=docs -e 'using Pkg; Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # GitHub automatically provides this
+        run: julia --project=docs docs/make.jl

docs/make.jl

@@ -4,23 +4,25 @@ using DocumenterVitepress
 
 DocMeta.setdocmeta!(MedImages, :DocTestSetup, :(using MedImages); recursive=true)
 
-makedocs(;
-    modules=[MedImages],
-    repo=Remotes.GitHub("JuliaHealth", "MedImage.jl"),
-    authors="Jakub-Mitura <[email protected]>, Divyansh-Goyal <[email protected]> and contributors",
-    sitename="MedImages.jl",
-    format=DocumenterVitepress.MarkdownVitepress(
-        repo="https://github.com/JuliaHealth/MedImages.jl",
-    ),
-    pages=[
-        "Home" => "index.md",
+pgs = [ "Home" => "index.md",
         "Tutorials" => "tutorials.md",
         "Contributing" => "contributing.md"
-    ],
-)
+       ]
+
+fmt = DocumenterVitepress.MarkdownVitepress(
+      repo = "https://github.com/Juliahealth/MedImages.jl",)
 
+
+makedocs(;
+    modules=[MedImages],
+    repo=Remotes.GitHub("JuliaHealth", "MedImages.jl"),
+    authors="Jakub-Mitura <[email protected]>, Divyansh-Goyal <[email protected]>, Jan-Zubik and contributors",
+    sitename="MedImages.jl",
+    format=fmt,
+    pages=pgs
+   )    
 deploydocs(;
-    repo="github.com/JuliaHealth/MedImage.jl",
+    repo="github.com/JuliaHealth/MedImages.jl",
     target="build", # this is where Vitepress stores its output
     devbranch="main",
     branch="gh-pages",