Merge pull request #370 from JuliaPhysics/documenter-update

Update to Documenter v1

.github/workflows/ci.yml

@@ -89,7 +89,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
         with:
-          version: '1'
+          version: '1.10'
       - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
         env:

docs/Project.toml

@@ -8,4 +8,4 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"
 
 [compat]
-Documenter = "0.27"
+Documenter = "1"

docs/make.jl

@@ -52,10 +52,11 @@ makedocs(
         "API" => "api.md",
         "LICENSE" => "LICENSE.md",
     ],
-    doctest = ("fixdoctests" in ARGS) ? :fix : true,
-    format = Documenter.HTML(canonical = "https://JuliaPhysics.github.io/SolidStateDetectors.jl/stable/", prettyurls = !("local" in ARGS)),
+    doctest   = ("fixdoctests" in ARGS) ? :fix : true,
+    format    = Documenter.HTML(canonical = "https://JuliaPhysics.github.io/SolidStateDetectors.jl/stable/", 
+                 prettyurls = !("local" in ARGS), size_threshold = nothing, size_threshold_warn = nothing, example_size_threshold = nothing),
     linkcheck = ("linkcheck" in ARGS),
-    strict = !("local" in ARGS),
+    warnonly  = ("nonstrict" in ARGS),
 )
 
 deploydocs(

src/ConstructiveSolidGeometry/CSG.jl

@@ -4,8 +4,6 @@
 A `CSGUnion` of two geometries `a` and `b` is defined as the set of points that are in at least 
 one of either `a` or `b` (`a || b`).
 
-![CSGUnion](../../docs/src/assets/CSGUnion.png)
-
 ## Parametric types
 * `T`: Precision type.
 * `A`: Type of geometry `a`.
@@ -64,8 +62,6 @@ UnionDictionary(g::AbstractGeometry{T}) where {T} = [Dictionary(g)]
 A `CSGIntersection` of two geometries `a` and `b` is defined as the set of points 
 that are both in `a` and in `b` (`a && b`).
 
-![CSGIntersection](../../docs/src/assets/CSGIntersection.png)
-
 ## Parametric types
 * `T`: Precision type.
 * `A`: Type of geometry `a`.
@@ -125,8 +121,6 @@ IntersectionDictionary(g::AbstractGeometry{T}) where {T} = [Dictionary(g)]
 A `CSGDifference` of two geometries `a` and `b` is defined as the set of points that are 
 in `a` but not in `b` (`a && !b`).
 
-![CSGDifference](../../docs/src/assets/CSGDifference.png)
-
 !!! note
     Note that `b` is treated as open primitive. This means that points which are in 
     `a` and on the surface of `b` will still be in the `CSGDifference` of `a` and `b`.