Set up documentation site with DocumenterVitepress

.github/workflows/Documenter.yml

@@ -0,0 +1,47 @@
+name: Documenter
+
+on:
+  push:
+    branches:
+      - master
+    tags: ['*']
+  pull_request:
+
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  statuses: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Setup Julia
+        uses: julia-actions/setup-julia@v2
+      - name: Load Julia packages from cache
+        id: julia-cache
+        uses: julia-actions/cache@v3
+      - name: Build and deploy docs
+        uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+          GKSwstype: "100"
+          JULIA_DEBUG: "Documenter"
+      - name: Save Julia depot cache on cancel or failure
+        id: julia-cache-save
+        if: cancelled() || failure()
+        uses: actions/cache/save@v5
+        with:
+          path: |
+            ${{ steps.julia-cache.outputs.cache-paths }}
+          key: ${{ steps.julia-cache.outputs.cache-key }}

README.md

@@ -52,6 +52,10 @@ plot!(collect.(boundary), aspectratio=1, lw=0, label="boundary")
 
 
 
+## Architecture
+
+See [docs/src/architecture.md](docs/src/architecture.md) for a detailed description of the internal pipeline from symbolic expressions to contractors and separators.
+
 ## Author
 
 - [David P. Sanders](http://sistemas.fciencias.unam.mx/~dsanders),

docs/Project.toml

@@ -1,3 +1,9 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
 IntervalArithmetic = "d1acc4aa-44c8-5952-acd4-ba5d80a2a253"
+IntervalConstraintProgramming = "138f1668-1576-5ad7-91b9-7425abbf3153"
+
+[compat]
+Documenter = "1"
+DocumenterVitepress = "0.3"

docs/make.jl

@@ -1,22 +1,28 @@
 using Documenter
+using DocumenterVitepress
 using IntervalConstraintProgramming, IntervalArithmetic
 
-makedocs(
+makedocs(;
     modules = [IntervalConstraintProgramming],
-    doctest = true,
-    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
     authors = "David P. Sanders",
     sitename = "IntervalConstraintProgramming.jl",
-
-    pages = Any[
+    format = DocumenterVitepress.MarkdownVitepress(;
+        repo = "github.com/JuliaIntervals/IntervalConstraintProgramming.jl",
+        devbranch = "master",
+        devurl = "dev",
+    ),
+    pages = [
         "Home" => "index.md",
-        "API" => "api.md"
-    ]
-    )
+        "Contractors and Separators" => "contractors_and_separators.md",
+        "Architecture" => "architecture.md",
+        "API" => "api.md",
+    ],
+)
 
-deploydocs(
-    repo = "github.com/JuliaIntervals/IntervalConstraintProgramming.jl.git",
-    target = "build",
-    deps = nothing,
-    make = nothing,
+DocumenterVitepress.deploydocs(;
+    repo = "github.com/JuliaIntervals/IntervalConstraintProgramming.jl",
+    target = joinpath(@__DIR__, "build"),
+    branch = "gh-pages",
+    devbranch = "master",
+    push_preview = true,
 )

docs/package.json

@@ -0,0 +1,14 @@
+{
+  "devDependencies": {
+    "@types/node": "^22.0.0"
+  },
+  "scripts": {
+    "docs:dev": "vitepress dev build/.documenter",
+    "docs:build": "vitepress build build/.documenter",
+    "docs:preview": "vitepress preview build/.documenter"
+  },
+  "dependencies": {
+    "vitepress": "^1.6.4",
+    "@mdit/plugin-mathjax": "^0.26.1"
+  }
+}