Skip to content

Commit 19b7944

Browse files
committed
fix doc
1 parent d0e1795 commit 19b7944

7 files changed

Lines changed: 9 additions & 12 deletions

File tree

docs/make.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@ with_api_reference(src_dir, ext_dir) do api_pages
193193
format=Documenter.HTML(;
194194
repolink="https://" * repo_url,
195195
prettyurls=false,
196-
example_size_threshold=1_000_000,
197-
size_threshold_warn=1_000_000,
198-
size_threshold=1_000_000,
196+
example_size_threshold=2_000_000,
197+
size_threshold_warn=2_000_000,
198+
size_threshold=2_000_000,
199199
assets=[
200200
asset("https://control-toolbox.org/assets/css/documentation.css"),
201201
asset("https://control-toolbox.org/assets/js/documentation.js"),

docs/src/api/public.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ boundary_constraints_dual
4141
boundary_constraints_nl
4242
bypass
4343
components
44-
constraint
4544
constraints
4645
constraints_violation
4746
control
@@ -116,7 +115,6 @@ methods
116115
model
117116
name
118117
nlp_model
119-
objective
120118
ocp_model
121119
ocp_solution
122120
option_default
@@ -149,7 +147,6 @@ time
149147
time_grid
150148
time_name
151149
times
152-
variable
153150
variable_components
154151
variable_constraints_box
155152
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`](@ref variable(::Solution)) 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` 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`](@ref)
104+
* `variable`
105105
* [`dynamics`](@ref)
106-
* [`objective`](@ref)
106+
* `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`](@ref variable(::Solution)) 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` 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

docs/src/manual-solve-gpu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ using CUDA
2222

2323
!!! note "Solver requirements"
2424

25-
For complete solver requirements including CPU solvers, see [Solver requirements](@ref manual-solve#solver-requirements) in the main solving manual.
25+
For complete solver requirements including CPU solvers, see [Solver requirements](@ref manual-solve-solver-requirements) in the main solving manual.
2626

2727
!!! warning "CUDA required"
2828

docs/src/manual-solve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ solve(ocp, :collocation, :ipopt) # specify discretizer + solver
173173
solve(ocp, :collocation, :adnlp, :ipopt, :cpu) # complete description
174174
```
175175

176-
## Solver requirements
176+
## [Solver requirements](@id manual-solve-solver-requirements)
177177

178178
Each solver requires its package to be loaded to provide the solver implementation:
179179

0 commit comments

Comments
 (0)