Skip to content

Commit 7eb17d2

Browse files
Fix docs
1 parent e76bdf0 commit 7eb17d2

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ const PAGES = [
8181
makedocs(;
8282
modules = [
8383
QuantumToolbox,
84-
Base.get_extension(QuantumToolbox, :QuantumToolboxCairoMakieExt),
84+
Base.get_extension(QuantumToolbox, :QuantumToolboxMakieExt),
8585
],
8686
authors = "Alberto Mercurio and Yi-Te Huang",
8787
repo = Remotes.GitHub("qutip", "QuantumToolbox.jl"),

docs/src/getting_started/logo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ xvec = range(-ρ, ρ, 500) .* 1.5
7676
yvec = xvec .+ (abs(imag(α1)) - abs(imag(α2))) / 2
7777
7878
fig = Figure(size = (250, 250), figure_padding = 0)
79-
fig, ax, hm = plot_wigner(ψ, xvec = xvec, yvec = yvec, g = 2, library = Val(:CairoMakie), location = fig[1,1])
79+
fig, ax, hm = plot_wigner(ψ, xvec = xvec, yvec = yvec, g = 2, library = Val(:Makie), location = fig[1,1])
8080
hidespines!(ax)
8181
hidexdecorations!(ax)
8282
hideydecorations!(ax)
@@ -110,7 +110,7 @@ And the Wigner function becomes more uniform:
110110

111111
```@example logo
112112
fig = Figure(size = (250, 250), figure_padding = 0)
113-
fig, ax, hm = plot_wigner(sol.states[end], xvec = xvec, yvec = yvec, g = 2, library = Val(:CairoMakie), location = fig[1,1])
113+
fig, ax, hm = plot_wigner(sol.states[end], xvec = xvec, yvec = yvec, g = 2, library = Val(:Makie), location = fig[1,1])
114114
hidespines!(ax)
115115
hidexdecorations!(ax)
116116
hideydecorations!(ax)

docs/src/users_guide/extensions/cairomakie.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# [Extension for CairoMakie.jl](@id doc:CairoMakie)
1+
# [Extension for the Makie.jl ecosystem](@id doc:Makie)
22

3-
This is an extension to support visualization (plotting functions) using [`CairoMakie.jl`](https://github.com/MakieOrg/Makie.jl/tree/master/CairoMakie) library.
3+
This is an extension to support visualization (plotting functions) using [`Makie.jl`](https://github.com/MakieOrg/Makie.jl) library.
44

5-
This extension will be automatically loaded if user imports both `QuantumToolbox.jl` and [`CairoMakie.jl`](https://github.com/MakieOrg/Makie.jl/tree/master/CairoMakie):
5+
This extension will be automatically loaded if user imports both `QuantumToolbox.jl` and [`Makie.jl`](https://github.com/MakieOrg/Makie.jl). It is worth noting that the `Makie.jl` package provides only the engine for plotting, and the user has to import the specific backend. Here we demonstrate the usage of [`CairoMakie.jl`](https://github.com/MakieOrg/Makie.jl/tree/master/CairoMakie), which will automatically import `Makie.jl`.
66

77
```julia
88
using QuantumToolbox
99
using CairoMakie
1010
```
1111

12-
To plot with [`CairoMakie.jl`](https://github.com/MakieOrg/Makie.jl/tree/master/CairoMakie) library, specify the keyword argument `library = Val(:CairoMakie)` for the plotting functions.
12+
To plot with [`CairoMakie.jl`](https://github.com/MakieOrg/Makie.jl/tree/master/CairoMakie) library, specify the keyword argument `library = Val(:Makie)` for the plotting functions.
1313

1414
!!! warning "Beware of type-stability!"
15-
If you want to keep type stability, it is recommended to use `Val(:CairoMakie)` instead of `:CairoMakie`. See [this link](https://docs.julialang.org/en/v1/manual/performance-tips/#man-performance-value-type) and the [related Section](@ref doc:Type-Stability) about type stability for more details.
15+
If you want to keep type stability, it is recommended to use `Val(:Makie)` instead of `:Makie`. See [this link](https://docs.julialang.org/en/v1/manual/performance-tips/#man-performance-value-type) and the [related Section](@ref doc:Type-Stability) about type stability for more details.
1616

1717
The supported plotting functions are listed as follows:
1818

0 commit comments

Comments
 (0)