Skip to content

Commit d3c62c8

Browse files
committed
fix ClimaCoreMakie doc generation
1 parent 3ce37ea commit d3c62c8

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ FFTW = "7a1cc6ca-52ef-59f5-83cd-3a7055c09341"
1212
IntervalSets = "8197267c-284f-5f27-9208-e0e47529a953"
1313
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
1414
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
15+
Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
1516
OrdinaryDiffEqSSPRK = "669c94d9-1f4b-4b64-b377-1aa079aa2388"
1617
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

docs/make.jl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import ClimaCore,
55
ClimaCorePlots,
66
ClimaCoreTempestRemap,
77
ClimaCoreSpectra
8+
using Makie # Required for Documenter to resolve @ref links to Makie types in ClimaCoreMakie docs
89

910
if !@isdefined(TUTORIALS)
1011
TUTORIALS = ["introduction"]
@@ -60,6 +61,7 @@ withenv("GKSwstype" => "nul") do
6061
sitename = "ClimaCore.jl",
6162
format = format,
6263
checkdocs = :exports,
64+
warnonly = [:cross_references], # Warn instead of error on unresolved @ref links (e.g., Makie.Linestyle)
6365
clean = true,
6466
doctest = true,
6567
modules = [

docs/src/lib/ClimaCoreMakie.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,12 @@ ClimaCoreMakie.jl provides functionality for plotting ClimaCore fields extending
88

99
```@docs
1010
fieldheatmap
11+
fieldheatmap!
12+
FieldHeatmap
1113
fieldcontourf
14+
fieldcontourf!
15+
FieldContourf
16+
fieldline
17+
fieldline!
18+
FieldLine
1219
```

lib/ClimaCoreMakie/src/fieldline.jl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
"""
2+
fieldline(field)
3+
4+
Plots a line plot of a 1D field.
5+
6+
## Attributes
7+
8+
Inherited from [`Makie.lines`](https://docs.makie.org/stable/examples/plotting_functions/lines/index.html#lines).
9+
10+
- `color` sets the color of the line.
11+
12+
- `linewidth` sets the width of the line.
13+
14+
- `linestyle` sets the style of the line (e.g., `:solid`, `:dash`, `:dot`).
15+
16+
See the [Makie.lines documentation](https://docs.makie.org/stable/examples/plotting_functions/lines/index.html#lines) for a complete list of attributes.
17+
"""
118
@recipe FieldLine (field,) begin
219
Makie.documented_attributes(Makie.Lines)...
320
end

0 commit comments

Comments
 (0)