Skip to content

Commit 9c72060

Browse files
committed
Fix documentation build warnings and HTML size error
- Double HTML size thresholds to 2 MB (manual-plot.md was 1.32 MiB) - Qualify constraint/objective/variable/discretize in public.md @docs block - Use qualified @ref for variable/objective in manual files - Add @id anchor to Solver requirements section in manual-solve.md - Fix @ref to use new anchor in manual-solve-gpu.md - Restrict methods() entry to avoid Base.methods docstring leak Resolves CI-blocking HTMLSizeThresholdError and eliminates local undefined binding warnings. Remaining @ref warnings require fixes in upstream packages (CTModels, CTSolvers, CTFlows).
1 parent 19b7944 commit 9c72060

4 files changed

Lines changed: 9 additions & 6 deletions

File tree

docs/src/api/public.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ boundary_constraints_dual
4141
boundary_constraints_nl
4242
bypass
4343
components
44+
CTModels.OCP.constraint
4445
constraints
4546
constraints_violation
4647
control
@@ -65,7 +66,7 @@ dim_path_constraints_nl
6566
dim_state_constraints_box
6667
dim_variable_constraints_box
6768
dimension
68-
discretize
69+
CTDirect.discretize
6970
dual
7071
dynamics
7172
export_ocp_solution
@@ -111,10 +112,11 @@ lagrange
111112
mayer
112113
message
113114
metadata
114-
methods
115+
methods()
115116
model
116117
name
117118
nlp_model
119+
CTModels.OCP.objective
118120
ocp_model
119121
ocp_solution
120122
option_default
@@ -147,6 +149,7 @@ time
147149
time_grid
148150
time_name
149151
times
152+
CTModels.OCP.variable
150153
variable_components
151154
variable_constraints_box
152155
variable_constraints_lb_dual

docs/src/manual-initial-guess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ nothing # hide
565565

566566
!!! tip "Interactions with an optimal control solution"
567567

568-
Please check [`state`](@ref), [`costate`](@ref), [`control`](@ref) and `variable` to get data from the solution. The functions `state`, `costate` and `control` return functions of time and `variable` returns a vector.
568+
Please check [`state`](@ref), [`costate`](@ref), [`control`](@ref) and [`variable`](@ref CTModels.OCP.variable) to get data from the solution. The functions `state`, `costate` and `control` return functions of time and `variable` returns a vector.
569569

570570
## Costate / multipliers
571571

docs/src/manual-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ Each field can be accessed directly (`ocp.times`, etc) or by a getter:
101101
* [`times`](@ref)
102102
* [`state`](@ref)
103103
* [`control`](@ref)
104-
* `variable`
104+
* [`variable`](@ref CTModels.OCP.variable)
105105
* [`dynamics`](@ref)
106-
* `objective`
106+
* [`objective`](@ref CTModels.OCP.objective)
107107
* [`constraints`](@ref)
108108
* [`definition`](@ref)
109109

docs/src/manual-plot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ The previous solution of the optimal control problem was obtained using the [`so
208208

209209
!!! tip "Interactions with an optimal control solution"
210210

211-
Please check [`state`](@ref), [`costate`](@ref), [`control`](@ref), and `variable` to retrieve data from the solution. The functions `state`, `costate`, and `control` return functions of time, while `variable` returns a vector.
211+
Please check [`state`](@ref), [`costate`](@ref), [`control`](@ref), and [`variable`](@ref CTModels.OCP.variable) to retrieve data from the solution. The functions `state`, `costate`, and `control` return functions of time, while `variable` returns a vector.
212212

213213
```@example main
214214
using OrdinaryDiffEq

0 commit comments

Comments
 (0)