Try DocumenterResolveXRefInMainPrototype

Author: goerz

.github/workflows/CI.yml

@@ -75,6 +75,7 @@ jobs:
       - name: "Instantiate test environment"
         run: |
           # Instantiate Pkg
+          rm -rf ~/.julia/registries/QuantumControlRegistry
           wget https://raw.githubusercontent.com/JuliaQuantumControl/JuliaQuantumControl/master/scripts/installorg.jl
           install -m 600 -D /dev/null ~/.ssh/known_hosts
           ssh-keyscan -H github.com > ~/.ssh/known_hosts

docs/make.jl

@@ -11,6 +11,9 @@ using DocumenterCitations
 using DocumenterInterLinks
 using Pkg
 
+Pkg.add(url="https://github.com/goerz/DocumenterResolveXRefInMainPrototype.jl.git")
+using DocumenterResolveXRefInMainPrototype
+
 PROJECT_TOML = Pkg.TOML.parsefile(joinpath(@__DIR__, "..", "Project.toml"))
 VERSION = PROJECT_TOML["version"]
 NAME = PROJECT_TOML["name"]

src/functionals.jl

@@ -424,7 +424,7 @@ The gradient ``∇_U J_T`` is obtained via automatic differentiation (AD). This
 requires that an AD package has been loaded (e.g., `using Zygote`). This
 package must either be passed as the `automatic` keyword argument, or the
 package must be set as the default AD provider using
-`QuantumControl.set_default_ad_framework`.
+[`QuantumControl.set_default_ad_framework`](@ref).
 
 Compared to the more general [`make_chi`](@ref) with `mode=:automatic`,
 `make_gate_chi` will generally have a slightly smaller numerical overhead, as

test/Project.toml

@@ -10,6 +10,7 @@ DocInventories = "43dc2714-ed3b-44b5-b226-857eda1aa7de"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
+DocumenterResolveXRefInMainPrototype = "ec50b518-6c18-4c34-be22-4983b883f12d"
 Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 FiniteDifferences = "26cc04aa-876d-5657-8c51-4c34ba976000"
 GRAPE = "6b52fcaf-80fe-489a-93e9-9f92080510be"
@@ -44,5 +45,5 @@ UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 
 [compat]
-Documenter = "1.1"
+Documenter = "1.3"
 julia = "1.9"