Skip to content

Commit 5c0f8f0

Browse files
committed
Update external references in docs
1 parent 5cdea37 commit 5c0f8f0

File tree

6 files changed

+23
-8
lines changed

6 files changed

+23
-8
lines changed

docs/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ QuantumControl = {path = ".."}
1414

1515
[compat]
1616
Documenter = "1.4"
17+
DocumenterInterLinks = "1.1"
1718
julia = "1.11"

docs/generate_api.jl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,12 @@ open(outfile, "w") do out
278278
## [Local Unexported Symbols](@id quantumcontrol-local-unexported-symbols)
279279
280280
```@docs
281-
QuantumControl.set_default_ad_framework
282281
QuantumControl.AbstractOptimizationResult
282+
QuantumControl.chain_callbacks
283+
QuantumControl.init_prop_trajectory
284+
QuantumControl.make_print_iters
285+
QuantumControl.set_atexit_save_optimization
286+
QuantumControl.set_default_ad_framework
283287
```
284288
""")
285289
write(out, raw"""

docs/make.jl

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
using Pkg
2-
Pkg.develop(path=joinpath(@__DIR__, ".."))
2+
if Base.VERSION < v"1.11"
3+
Pkg.develop(path=joinpath(@__DIR__, ".."))
4+
end
35

46
using Documenter
57
using QuantumPropagators
@@ -64,6 +66,17 @@ links = InterLinks(
6466
"DrWatson" => "https://juliadynamics.github.io/DrWatson.jl/stable/",
6567
)
6668

69+
fallbacks = DocumenterInterLinks.ExternalFallbacks(
70+
"GRAPE-Background" => "@extref GRAPE :std:label:`GRAPE-Background`",
71+
"QuantumGradientGenerators.GradVector" => "@extref QuantumGradientGenerators :jl:type:`QuantumGradientGenerators.GradVector`",
72+
"howto_parameterized" => "@extref QuantumPropagators :std:label:`howto_parameterized`",
73+
"KrotovResult" => "@extref Krotov :jl:type:`Krotov.KrotovResult`",
74+
"KrotovWrk" => "@extref Krotov :jl:type:`Krotov.KrotovWrk`",
75+
"GrapeResult" => "@extref GRAPE :jl:type:`GRAPE.GrapeResult`",
76+
"GrapeWrk" => "@extref GRAPE :jl:type:`GRAPE.GrapeWrk`";
77+
automatic=false,
78+
)
79+
6780
println("Starting makedocs")
6881

6982
include("generate_api.jl")
@@ -76,7 +89,7 @@ if get(ENV, "DOCUMENTER_WARN_ONLY", "0") == "1" # cf. test/init.jl
7689
end
7790

7891
makedocs(;
79-
plugins=[bib, links],
92+
plugins=[bib, links, fallbacks],
8093
authors=AUTHORS,
8194
sitename="QuantumControl.jl",
8295
# Link checking is disabled in REPL, see `devrepl.jl`.
@@ -121,7 +134,6 @@ makedocs(;
121134
"QuantumControl" => "api/quantum_control.md",
122135
"Reference" => "api/reference.md",
123136
"Subpackages" => ["QuantumPropagators" => "api/quantum_propagators.md",],
124-
"Externals" => "api_externals.md",
125137
"Index" => "api/quantum_control_index.md",
126138
],
127139
"References" => "references.md",

docs/src/api_externals.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/src/refs.bib

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ @article{FouquieresJMR2011
350350
}
351351

352352

353-
@article{KuprovJCP09,
353+
@article{KuprovJCP2009,
354354
Author = {Kuprov, Ilya and Rodgers, Christopher T.},
355355
Title = {Derivatives of spin dynamics simulations},
356356
Journal = jcp,

test/Project.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,5 @@ QuantumControl = {path = ".."}
5353

5454
[compat]
5555
Documenter = "1.4"
56+
DocumenterInterLinks = "1.1"
5657
julia = "1.9"

0 commit comments

Comments
 (0)