Fix #135: Switch documentation to DocumenterVitepress

.gitignore

@@ -66,7 +66,7 @@ distributions-knowledge-base.md
 lcov.info
 worktree-*
 
-# Node.js dependencies and package files
+# Documentation dependencies
 docs/node_modules/
 docs/package-lock.json
 docs/package.json

README.md

@@ -1,15 +1,8 @@
 # CensoredDistributions.jl <img src="docs/src/assets/logo.svg" width="150" alt="CensoredDistributions.jl logo" align="right">
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://www.CensoredDistributions.epiaware.org/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://www.CensoredDistributions.epiaware.org/dev/)
-[![Test](https://github.com/EpiAware/CensoredDistributions.jl/actions/workflows/test.yaml/badge.svg)](https://github.com/EpiAware/CensoredDistributions.jl/actions/workflows/test.yaml)
-[![codecov](https://codecov.io/gh/EpiAware/CensoredDistributions.jl/graph/badge.svg)](https://codecov.io/gh/EpiAware/CensoredDistributions.jl)
-
-[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
-[![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
-[![JET](https://img.shields.io/badge/%E2%9C%88%EF%B8%8F%20tested%20with%20-%20JET.jl%20-%20red)](https://github.com/aviatesk/JET.jl)
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+| **Documentation** | **Build Status** | **Julia** | **Testing** | **Licence** |
+|:-----------------:|:----------------:|:---------:|:-----------:|:-----------:|
+| [![docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://www.CensoredDistributions.epiaware.org/) [![docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://www.CensoredDistributions.epiaware.org/dev/) | [![CI](https://github.com/EpiAware/CensoredDistributions.jl/actions/workflows/test.yaml/badge.svg)](https://github.com/EpiAware/CensoredDistributions.jl/actions/workflows/test.yaml) | [![Julia](https://img.shields.io/badge/julia-v1.10+-blue.svg)](https://julialang.org/) [![Code Style: Blue](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle) | [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) [![JET](https://img.shields.io/badge/%E2%9C%88%EF%B8%8F%20tested%20with%20-%20JET.jl%20-%20red)](https://github.com/aviatesk/JET.jl) [![codecov](https://codecov.io/gh/EpiAware/CensoredDistributions.jl/graph/badge.svg)](https://codecov.io/gh/EpiAware/CensoredDistributions.jl) | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) |
 
 *Additional censored event tools for Distributions.jl*
 

docs/Project.toml

@@ -7,6 +7,7 @@ Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 DataFramesMeta = "1313f7d8-7da2-5740-9ea0-a2ca25f37964"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
 DynamicPPL = "366bfd00-2699-11ea-058f-f148b4cae6d8"
 Integrals = "de52edbc-65ea-441a-8357-d3a637375a31"
 Optimization = "7f7a1694-90dd-40f0-9382-eb1efda571ba"

docs/build.jl

@@ -5,7 +5,7 @@ function build(target_subdir; _module = CensoredDistributions)
 
     @info "Building notebooks in $target_subdir"
     # Evaluate notebooks in the same process to avoid having to recompile from scratch each time.
-    # This is similar to how Documenter and Franklin evaluate code.
+    # This is similar to how DocumenterVitepress and Franklin evaluate code.
     # Note that things like method overrides and other global changes may leak between notebooks!
     use_distributed = false
     output_format = documenter_output
@@ -14,7 +14,7 @@ function build(target_subdir; _module = CensoredDistributions)
     return nothing
 end
 
-"Return Markdown file links which can be passed to Documenter.jl."
+"Return Markdown file links which can be passed to DocumenterVitepress.jl."
 function markdown_files(notebook_titles, target_subdir)
     md_files = map(notebook_titles) do title
         file = lowercase(replace(title, " " => '_'))

docs/make.jl

@@ -1,6 +1,7 @@
 using Pkg: Pkg
 Pkg.instantiate()
 
+using DocumenterVitepress
 using Documenter
 using CensoredDistributions
 
@@ -20,15 +21,18 @@ if !skip_notebooks
     build("getting-started/tutorials")
     println("✓ Notebook processing complete")
 else
-    println("⚠ Skipping Pluto notebook processing (--skip-notebooks or SKIP_NOTEBOOKS=true)")
+    println("⚠ Skipping Pluto notebook processing (--skip-notebooks or " *
+            "SKIP_NOTEBOOKS=true)")
     include("pages.jl")
 end
 
 # Generate index.md from README.md
 open(joinpath(joinpath(@__DIR__, "src"), "index.md"), "w") do io
     println(io, "```@meta")
     println(io,
-        "EditURL = \"https://github.com/EpiAware/CensoredDistributions.jl/blob/main/README.md\"")
+        "EditURL = " *
+        "\"https://github.com/EpiAware/CensoredDistributions.jl/blob/main/" *
+        "README.md\"")
     println(io, "```")
 
     for line in eachline(joinpath(dirname(@__DIR__), "README.md"))
@@ -38,7 +42,8 @@ open(joinpath(joinpath(@__DIR__, "src"), "index.md"), "w") do io
             # Remove logo from title line for documentation
         elseif contains(line, "docs/src/assets/logo.svg")
             # Remove the entire logo img tag from the title
-            println(io, replace(line, r"\s*<img[^>]*docs/src/assets/logo\.svg[^>]*>" => ""))
+            println(io, replace(line,
+                r"\s*<img[^>]*docs/src/assets/logo\.svg[^>]*>" => ""))
         else
             println(io, line)
         end
@@ -66,26 +71,26 @@ else
     println("⚠ NEWS.md not found in project root")
 end
 
-DocMeta.setdocmeta!(
-    CensoredDistributions, :DocTestSetup, :(using CensoredDistributions); recursive = true)
+DocMeta.setdocmeta!(CensoredDistributions, :DocTestSetup,
+    :(using CensoredDistributions); recursive = true)
 
 makedocs(; sitename = "CensoredDistributions.jl",
     authors = "Sam Abbott, and contributors",
     clean = true, doctest = false, linkcheck = true,
     warnonly = [:docs_block, :missing_docs, :linkcheck, :autodocs_block],
     modules = [CensoredDistributions],
     pages = pages,
-    format = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true",
-        mathengine = Documenter.MathJax3(),
-        size_threshold = 6000 * 2^10,
-        size_threshold_warn = 2000 * 2^10,
-        collapselevel = 2  # Collapse docstrings at level 2 by default
+    format = DocumenterVitepress.MarkdownVitepress(
+        repo = "github.com/EpiAware/CensoredDistributions.jl",
+        devbranch = "main",
+        devurl = "dev"
     )
 )
 
-deploydocs(
-    repo = "github.com/EpiAware/CensoredDistributions.jl.git",
+DocumenterVitepress.deploydocs(
+    repo = "github.com/EpiAware/CensoredDistributions.jl",
     target = "build",
+    branch = "gh-pages",
+    devbranch = "main",
     push_preview = true
 )