Skip to content

Commit d647c94

Browse files
committed
doc is ok
1 parent 295c297 commit d647c94

File tree

8 files changed

+27
-99
lines changed

8 files changed

+27
-99
lines changed

Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "OptimalControl"
22
uuid = "5f98b655-cc9a-415a-b60e-744165666948"
33
authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
4-
version = "0.12.3"
4+
version = "0.13.0"
55

66
[deps]
77
CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"
@@ -13,7 +13,7 @@ DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
1313
[compat]
1414
CTBase = "0.14"
1515
CTDirect = "0.13"
16-
CTFlows = "0.7.0"
16+
CTFlows = "0.7"
1717
CommonSolve = "0.2"
1818
DocStringExtensions = "0.9"
1919
julia = "1.10"

docs/Project.toml

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,35 @@ CTDirect = "790bbbee-bee9-49ee-8912-a9de031322d5"
44
CTFlows = "1c39547c-7794-42f7-af83-d98194f657c2"
55
CommonSolve = "38540f10-b2f7-11e9-35d8-d573e4eb0ff2"
66
DifferentiationInterface = "a0c0ee7d-e4b9-4e03-894e-1c5f64a51d63"
7+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
78
DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
89
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
910
JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
1011
JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
1112
MINPACK = "4854310b-de5a-5eb6-a2a5-c1dee2bd17f9"
13+
MadNLP = "2621e9c9-9eb4-46b1-8089-e8c72242dfb6"
1214
NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
13-
OptimalControl = "5f98b655-cc9a-415a-b60e-744165666948"
1415
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
1516
Percival = "01435c0c-c90d-11e9-3788-63660f8fbccc"
1617
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
18+
Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
1719

1820
[compat]
1921
CTBase = "0.14"
2022
CTDirect = "0.13"
21-
CTFlows = "0.7.0"
23+
CTFlows = "0.7"
2224
CommonSolve = "0.2"
25+
DifferentiationInterface = "0.6"
26+
Documenter = "1.8"
27+
DocumenterMermaid = "0.1"
28+
ForwardDiff = "0.10"
29+
JLD2 = "0.5"
30+
JSON3 = "1.14"
31+
MINPACK = "1.3"
32+
MadNLP = "0.8"
33+
NonlinearSolve = "4.4"
2334
OrdinaryDiffEq = "6"
35+
Percival = "0.7"
36+
Plots = "1.40"
37+
Suppressor = "0.2"
2438
julia = "1.10"

docs/make.jl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ makedocs(;
3838
"Solve" => "tutorial-solve.md",
3939
"Plot a solution" => "tutorial-plot.md",
4040
"Flow" => "tutorial-flow.md",
41-
"Functional syntax" => "tutorial-functional.md",
4241
"Control-toolbox REPL" => "tutorial-repl.md",
4342
],
4443
"Tutorials" => [

docs/src/tutorial-double-integrator-energy.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ nothing # hide
5151

5252
!!! note "Nota bene"
5353

54-
For a comprehensive introduction to the syntax used above to describe the optimal control problem, check [this abstract syntax tutorial](@ref abstract). In particular, there are non-unicode alternatives for derivatives, integrals, *etc.* There is also a non-standard but more classical functional syntax, check [this functional syntax tutorial](@ref functional).
54+
For a comprehensive introduction to the syntax used above to describe the optimal control problem, check [this abstract syntax tutorial](@ref abstract). In particular, there are non-unicode alternatives for derivatives, integrals, *etc.*
5555

5656
## [Solve and plot](@id basic-solve-plot)
5757

@@ -107,7 +107,10 @@ We can save the solution in a Julia `.jld2` data file and reload it later, and a
107107
using JLD2, JSON3
108108
109109
# JLD save / load
110+
using Suppressor # hide
111+
@suppress_err begin # hide
110112
export_ocp_solution(sol; filename_prefix="my_solution")
113+
end # hide
111114
sol_reloaded = import_ocp_solution(ocp; filename_prefix="my_solution")
112115
println("Objective from loaded solution: ", sol_reloaded.objective)
113116

docs/src/tutorial-double-integrator-time.md

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

7171
!!! note "Nota bene"
7272

73-
For a comprehensive introduction to the syntax used above to describe the optimal control problem, check [this abstract syntax tutorial](@ref abstract). In particular, there are non-unicode alternatives for derivatives, integrals, *etc.* There is also a non-standard but more classical functional syntax, check [this functional syntax tutorial](@ref functional).
73+
For a comprehensive introduction to the syntax used above to describe the optimal control problem, check [this abstract syntax tutorial](@ref abstract). In particular, there are non-unicode alternatives for derivatives, integrals, *etc.*
7474

7575
## Solve and plot
7676

docs/src/tutorial-flow.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ end
9191
u(x, p) = p[2]
9292
```
9393

94-
```@repl main_repl
95-
f = Flow(ocp, u)
94+
```julia
95+
julia> f = Flow(ocp, u)
96+
ERROR: ExtensionError. Please make: julia> using OrdinaryDiffEq
9697
```
9798

9899
As you can see, an error occured since we need the package [OrdinaryDiffEq.jl](https://docs.sciml.ai/DiffEqDocs).

docs/src/tutorial-goddard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ nothing # hide
106106
We then solve it
107107

108108
```@example main
109-
direct_sol = solve(ocp)
109+
direct_sol = solve(ocp; grid_size=100)
110110
nothing # hide
111111
```
112112

docs_to_update/tutorial-functional.md

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

0 commit comments

Comments
 (0)