Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Documenter v1 #370

Merged
merged 3 commits into from
Dec 29, 2024
Merged

Update to Documenter v1 #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b404d5c
Update to Documenter v1
oschulz Feb 1, 2024
6724a68
Remove links to images in CSG docstrings
fhagemann Feb 5, 2024
039eb82
Build documentation on `julia-1.10`
fhagemann Dec 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
Unitful = "1986cc42-f94f-5a68-af5c-568840ba703d"

[compat]
Documenter = "0.27"
Documenter = "1"
7 changes: 4 additions & 3 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
6 changes: 0 additions & 6 deletions src/ConstructiveSolidGeometry/CSG.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -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`.
Expand Down
Loading