Adapt documentation to refactored GRAPE

goerz · goerz · commit bebc3963722d · 2025-10-01T14:47:49.000-04:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -73,7 +73,8 @@ fallbacks = DocumenterInterLinks.ExternalFallbacks(
     "KrotovResult" => "@extref Krotov :jl:type:`Krotov.KrotovResult`",
     "KrotovWrk" => "@extref Krotov :jl:type:`Krotov.KrotovWrk`",
     "GrapeResult" => "@extref GRAPE :jl:type:`GRAPE.GrapeResult`",
-    "GrapeWrk" => "@extref GRAPE :jl:type:`GRAPE.GrapeWrk`";
+    "make_grape_print_iters" => "@extref GRAPE :jl:function:`GRAPE.make_grape_print_iters`",
+    "GrapeWrk" => "@extref GRAPE :jl:type:`GRAPE.GrapeWrk`",
     automatic=false,
 )
 
diff --git a/docs/src/methods.md b/docs/src/methods.md
@@ -28,3 +28,8 @@ The Gradient Ascent Pulse Engineering (GRAPE) method is implemented in the [`GRA
 ```@docs; canonical=false
 optimize(::ControlProblem, ::Val{:GRAPE})
 ```
+
+```@docs
+GRAPE.optimize
+```
+

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,8 @@ fallbacks = DocumenterInterLinks.ExternalFallbacks(`
`73`	`73`	"KrotovResult" => "@extref Krotov :jl:type:`Krotov.KrotovResult`",
`74`	`74`	"KrotovWrk" => "@extref Krotov :jl:type:`Krotov.KrotovWrk`",
`75`	`75`	"GrapeResult" => "@extref GRAPE :jl:type:`GRAPE.GrapeResult`",
`76`		- "GrapeWrk" => "@extref GRAPE :jl:type:`GRAPE.GrapeWrk`";
	`76`	+ "make_grape_print_iters" => "@extref GRAPE :jl:function:`GRAPE.make_grape_print_iters`",
	`77`	+ "GrapeWrk" => "@extref GRAPE :jl:type:`GRAPE.GrapeWrk`",
`77`	`78`	`automatic=false,`
`78`	`79`	`)`
`79`	`80`