From b404d5c4717126ca6c0c10efe9e517ae2465beb8 Mon Sep 17 00:00:00 2001 From: Oliver Schulz Date: Thu, 1 Feb 2024 14:33:52 +0100 Subject: [PATCH 1/3] Update to Documenter v1 --- docs/Project.toml | 2 +- docs/make.jl | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index 8ec6c602c..57cf81592 100644 --- a/docs/Project.toml +++ b/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" diff --git a/docs/make.jl b/docs/make.jl index b14cbc2c5..e85d93733 100644 --- a/docs/make.jl +++ b/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( From 6724a686ed4ba2e1d9aa4648bf87241c40e2493a Mon Sep 17 00:00:00 2001 From: Felix Hagemann Date: Mon, 5 Feb 2024 05:02:02 +0100 Subject: [PATCH 2/3] Remove links to images in CSG docstrings --- src/ConstructiveSolidGeometry/CSG.jl | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/ConstructiveSolidGeometry/CSG.jl b/src/ConstructiveSolidGeometry/CSG.jl index cb4a44151..81e226c93 100644 --- a/src/ConstructiveSolidGeometry/CSG.jl +++ b/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`. From 039eb82e65ef24b39e212f7003c2a99d2828ddbc Mon Sep 17 00:00:00 2001 From: Felix Hagemann Date: Sun, 29 Dec 2024 20:39:31 +0000 Subject: [PATCH 3/3] Build documentation on `julia-1.10` --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bd0433bcf..d1570cdf4 100644 --- a/.github/workflows/ci.yml +++ b/.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: