Skip to content

Commit b2fcefc

Browse files
authored
Merge pull request #504 from control-toolbox/503-doc-remove-tutorials
Remove tutorials
2 parents 51d59ff + 7d3a285 commit b2fcefc

28 files changed

+36
-1345
lines changed

docs/Project.toml

-14
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,34 @@
11
[deps]
2-
BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
32
CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"
43
CTDirect = "790bbbee-bee9-49ee-8912-a9de031322d5"
54
CTFlows = "1c39547c-7794-42f7-af83-d98194f657c2"
65
CTModels = "34c4fa32-2049-4079-8329-de33c2a22e2d"
76
CTParser = "32681960-a1b1-40db-9bff-a1ca817385d1"
8-
CommonSolve = "38540f10-b2f7-11e9-35d8-d573e4eb0ff2"
9-
DifferentiationInterface = "a0c0ee7d-e4b9-4e03-894e-1c5f64a51d63"
107
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
118
DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
12-
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
139
JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
1410
JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
1511
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
16-
MINPACK = "4854310b-de5a-5eb6-a2a5-c1dee2bd17f9"
1712
MadNLP = "2621e9c9-9eb4-46b1-8089-e8c72242dfb6"
1813
NLPModelsIpopt = "f4238b75-b362-5c4c-b852-0801c9a21d71"
19-
NonlinearSolve = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
2014
OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
21-
Percival = "01435c0c-c90d-11e9-3788-63660f8fbccc"
2215
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
2316
Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb"
2417

2518
[compat]
26-
BenchmarkTools = "1.6"
2719
CTBase = "0.16"
2820
CTDirect = "0.14"
2921
CTFlows = "0.8"
3022
CTModels = "0.3"
3123
CTParser = "0.2"
32-
CommonSolve = "0.2"
33-
DifferentiationInterface = "0.6"
3424
Documenter = "1.8"
3525
DocumenterMermaid = "0.2"
36-
ForwardDiff = "0.10"
3726
JLD2 = "0.5"
3827
JSON3 = "1.14"
3928
LinearAlgebra = "1"
40-
MINPACK = "1.3"
4129
MadNLP = "0.8"
4230
NLPModelsIpopt = "0.10"
43-
NonlinearSolve = "4.6"
4431
OrdinaryDiffEq = "6.93"
45-
Percival = "0.7"
4632
Plots = "1.40"
4733
Suppressor = "0.2"
4834
julia = "1"

docs/make.jl

+1-10
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ makedocs(;
2121
sitename="OptimalControl.jl",
2222
format=Documenter.HTML(;
2323
repolink="https://" * repo_url,
24-
prettyurls=true,
24+
prettyurls=false,
2525
size_threshold_ignore=[
2626
"api-ctbase/types.md", "dev-ctmodels.md", "tutorial-plot.md"
2727
],
@@ -43,15 +43,6 @@ makedocs(;
4343
"Plot a solution" => "tutorial-plot.md",
4444
"Compute flows" => "tutorial-flow.md",
4545
],
46-
"Tutorials and Advanced Features" => [
47-
"Discrete continuation" => "tutorial-continuation.md",
48-
"Discretisation methods" => "tutorial-discretisation.md",
49-
"NLP manipulations" => "tutorial-nlp.md",
50-
"Indirect simple shooting" => "tutorial-iss.md",
51-
"Goddard: direct, indirect" => "tutorial-goddard.md",
52-
"Linear–quadratic regulator" => "tutorial-lqr-basic.md",
53-
"Minimal action" => "tutorial-mam.md",
54-
],
5546
"Developers" => [
5647
"OptimalControl.jl" => "dev-optimalcontrol.md",
5748
"Subpackages" => [
-491 KB
Binary file not shown.

docs/src/assets/ct-repl-95x30.gif

-2.06 MB
Binary file not shown.

docs/src/assets/ct-repl-95x60.gif

-3.36 MB
Binary file not shown.

docs/src/assets/repl.mp4

-5.61 MB
Binary file not shown.

docs/src/dev-ctbase.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [CTBase.jl](control-toolbox.org/CTBase.jl/) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [CTBase.jl](https://github.com/control-toolbox/CTBase.jl/) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/dev-ctdirect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [CTDirect.jl](control-toolbox.org/CTDirect.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [CTDirect.jl](https://github.com/control-toolbox/CTDirect.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/dev-ctflows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [CTFlows.jl](control-toolbox.org/CTFlows.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [CTFlows.jl](https://github.com/control-toolbox/CTFlows.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/dev-ctmodels.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [CTModels.jl](control-toolbox.org/CTModels.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [CTModels.jl](https://github.com/control-toolbox/CTModels.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/dev-ctparser.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [CTParser.jl](control-toolbox.org/CTParser.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [CTParser.jl](https://github.com/control-toolbox/CTParser.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/dev-optimalcontrol.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
CollapsedDocStrings = false
55
```
66

7-
The [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
7+
The [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
88

99
```mermaid
1010
flowchart TD

docs/src/juliacon2024.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ plus boundary conditions, control and state constraints
3030

3131
## OptimalControl.jl for trajectory optimisation
3232

33-
- [Basic example](tutorial-double-integrator-energy.html)
34-
- [Goddard problem](tutorial-goddard.html)
33+
- [Basic example](@ref tutorial-double-integrator-energy)
34+
- [Goddard problem](https://control-toolbox.org/Tutorials.jl/stable/tutorial-goddard/)
3535
- [Orbit transfer](https://control-toolbox.org/Kepler.jl)
3636

3737
## Wrap up
@@ -58,8 +58,8 @@ plus boundary conditions, control and state constraints
5858
## Credits (not exhaustive!)
5959

6060
- [ADNLPModels.jl](https://jso.dev/ADNLPModels.jl)
61-
- [DifferentiationInterface.jl](https://gdalle.github.io/DifferentiationInterface.jl/DifferentiationInterface/stable)
62-
- [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl)
61+
- [DifferentiationInterface.jl](https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface)
62+
- [DifferentialEquations.jl](https://docs.sciml.ai/DiffEqDocs)
6363
- [MLStyle.jl](https://thautwarm.github.io/MLStyle.jl)
6464

6565
## Acknowledgements

docs/src/tutorial-abstract.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The full grammar of [OptimalControl.jl](https://control-toolbox.org/OptimalContr
44
- pure Julia (and, as such, effortlessly analysed by the standard Julia parser),
55
- as close as possible to the mathematical description of an optimal control problem.
66

7-
While the syntax will be transparent to those users familiar with Julia expressions (`Expr`'s), we provide examples for every case that should be widely understandable. We rely heavily on [MLStyle.jl](https://github.com/thautwarm/MLStyle.jl) and its pattern matching abilities 👍🏽 for the semantic pass. Abstract definitions use the macro `@def`.
7+
While the syntax will be transparent to those users familiar with Julia expressions (`Expr`'s), we provide examples for every case that should be widely understandable. We rely heavily on [MLStyle.jl](https://thautwarm.github.io/MLStyle.jl) and its pattern matching abilities 👍🏽 for the semantic pass. Abstract definitions use the macro `@def`.
88

99
## [Variable](@id tutorial-abstract-variable)
1010

@@ -77,7 +77,7 @@ tf = 5
7777
end
7878
```
7979

80-
One (or even the two bounds) can be variable, typically for minimum time problems (see [Mayer cost](#mayer) section):
80+
One (or even the two bounds) can be variable, typically for minimum time problems (see [Mayer cost](@ref tutorial-abstract-mayer) section):
8181

8282
```julia
8383
@def begin
@@ -208,7 +208,7 @@ F₁(x) = [0, 1]
208208
!!! note
209209
The vector fields `F₀` and `F₁` can be defined afterwards, as they only need to be available when the dynamics will be evaluated.
210210

211-
Currently, it is not possible to declare the dynamics component after component, but a simple workaround is to use *aliases* (check the relevant [aliases](#aliases) section below):
211+
Currently, it is not possible to declare the dynamics component after component, but a simple workaround is to use *aliases* (check the relevant [aliases](@ref tutorial-abstract-aliases) section below):
212212

213213
```julia
214214
@def damped_integrator begin
@@ -471,7 +471,7 @@ end
471471
:( $a = $e1 )
472472
```
473473

474-
The single `=` symbol is used to define not a constraint but an alias, that is a purely syntactic replacement. There are some automatic aliases, *e.g.* `x₁` for `x[1]` if `x` is the state, and we have also seen that the user can define her own aliases when declaring the [variable](#variable), [state](#state) and [control](#control). Arbitrary aliases can be further defined, as below (compare with previous examples in the [dynamics](#dynamics) section):
474+
The single `=` symbol is used to define not a constraint but an alias, that is a purely syntactic replacement. There are some automatic aliases, *e.g.* `x₁` for `x[1]` if `x` is the state, and we have also seen that the user can define her own aliases when declaring the [variable](@ref tutorial-abstract-variable), [state](@ref tutorial-abstract-state) and [control](@ref tutorial-abstract-control). Arbitrary aliases can be further defined, as below (compare with previous examples in the [dynamics](@ref tutorial-abstract-dynamics) section):
475475

476476
```julia
477477
@def begin

docs/src/tutorial-continuation.md

-141
This file was deleted.

0 commit comments

Comments
 (0)