Skip to content

Commit 723874e

Browse files
authored
Fix docs build error (#286)
* Fix docs build error * Add AdaptivePredicates to docs project * Use AdaptivePredicates in orient descriptoin * for some reason `@ref` is not working here * using * try to fix missing docstring by namespacing
1 parent 87c2c7b commit 723874e

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

GeometryOpsCore/src/types/exceptions.jl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ that have nice show methods that we can use for certain errors.
77
This makes it substantially easier to catch specific kinds of errors and show them.
88
For example, we can catch `WrongManifoldException` and show a nice error message,
99
and error hinters can be specialized to that as well.
10+
11+
```@docs; canonical=false
12+
GeometryOpsCore.WrongManifoldException
13+
```
1014
=#
1115

1216
export WrongManifoldException
@@ -16,7 +20,7 @@ export WrongManifoldException
1620
1721
This error is thrown when an `Algorithm` is called with a manifold that it was not designed for.
1822
19-
It's mainly called for [`SingleManifoldAlgorithm`](@ref) types.
23+
It's mainly thrown when constructing `SingleManifoldAlgorithm` types.
2024
"""
2125
struct WrongManifoldException{InputManifold, DesiredManifold, Algorithm} <: Base.Exception
2226
description::String

docs/Project.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[deps]
22
AccurateArithmetic = "22286c92-06ac-501d-9306-4abd417d9753"
3+
AdaptivePredicates = "35492f91-a3bd-45ad-95db-fcad7dcfedb7"
34
Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"
45
BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
56
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
@@ -41,8 +42,7 @@ Proj = "c94c279d-25a6-4763-9509-64d165bea63e"
4142
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
4243
Shapefile = "8e980c4a-a4fe-5da2-b3a7-4b4b0353a2f4"
4344
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
44-
Weave = "44d3d7a6-8a23-5bf8-98c5-b353f8df5ec9"
4545

4646
[sources]
47-
GeometryOps = { path = "../" }
48-
GeometryOpsCore = { path = "../GeometryOpsCore" }
47+
GeometryOps = {path = "../"}
48+
GeometryOpsCore = {path = "../GeometryOpsCore"}

docs/src/api.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Documentation for [GeometryOps](https://github.com/JuliaGeo/GeometryOps.jl)'s fu
1212
```@index
1313
```
1414

15-
## `apply` and associated functions
15+
## [`apply` and associated functions](@id Primitive-functions)
1616
```@docs
1717
apply
1818
applyreduce
@@ -59,3 +59,8 @@ barycentric_interpolate
5959
```@autodocs
6060
Modules = [GeometryOps]
6161
```
62+
63+
## Core types
64+
```@autodocs
65+
Modules = [GeometryOpsCore]
66+
```

docs/src/experiments/predicates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Exact vs fast predicates
77
```@example orient
88
using CairoMakie
99
import GeometryOps as GO, GeoInterface as GI, LibGEOS as LG
10-
import ExactPredicates
10+
import ExactPredicates, AdaptivePredicates
1111
using MultiFloats
1212
using Chairmarks: @be
1313
using BenchmarkTools: prettytime
@@ -25,7 +25,7 @@ function orient_adaptive(p, q, r)
2525
end
2626
# Create an interactive Makie dashboard which can show what is done here
2727
labels = ["Float64", "Adaptive", "Exact"]
28-
funcs = [orient_f64, orient_adaptive, ExactPredicates.orient]
28+
funcs = [orient_f64, AdaptivePredicates.orient2, ExactPredicates.orient]
2929
fig = Figure()
3030
axs = [Axis(fig[1, i]; aspect = DataAspect(), xticklabelrotation = pi/4, title) for (i, title) in enumerate(labels)]
3131
w, r, q, p = 42.0, 0.95, 18.0, 16.8
@@ -54,7 +54,7 @@ fig
5454
```julia
5555
using WGLMakie
5656
import GeometryOps as GO, GeoInterface as GI, LibGEOS as LG
57-
import ExactPredicates
57+
import ExactPredicates, AdaptivePredicates
5858
using MultiFloats
5959

6060
function orient_f64(p, q, r)

0 commit comments

Comments
 (0)