Merge pull request #230 from control-toolbox/229-no-aggregation-anymore

ocots · web-flow · commit 948d7830d2df · 2024-07-12T18:00:15.000+02:00
foo
diff --git a/README.md b/README.md
@@ -7,10 +7,10 @@
 [co-url]: https://codecov.io/gh/control-toolbox/OptimalControl.jl
 
 [doc-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
-[doc-dev-url]: https://control-toolbox.org/docs/optimalcontrol/dev/
+[doc-dev-url]: https://control-toolbox.org/OptimalControl.jl/dev/
 
 [doc-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
-[doc-stable-url]: https://control-toolbox.org/docs/optimalcontrol/stable/
+[doc-stable-url]: https://control-toolbox.org/OptimalControl.jl/stable/
 
 [down-img]: https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/OptimalControl
 [down-url]: https://pkgs.genieframework.com?packages=OptimalControl
diff --git a/docs/make.jl b/docs/make.jl
@@ -16,8 +16,14 @@ DocMeta.setdocmeta!(OptimalControl, :DocTestSetup, :(using OptimalControl); recu
 makedocs(
     warnonly = :cross_references,
     sitename = "OptimalControl.jl",
-    format = Documenter.HTML(prettyurls = false,
-                             size_threshold_ignore = ["api-ctbase.md", "application-mri-saturation.md"]),
+    format = Documenter.HTML(
+        prettyurls = false,
+        size_threshold_ignore = ["api-ctbase.md", "application-mri-saturation.md"],
+        assets=[
+            asset("https://control-toolbox.org/assets/css/documentation.css"),
+            asset("https://control-toolbox.org/assets/js/documentation.js"),
+        ],
+    ),
     pages = [
         "Introduction" => "index.md",
         "Tutorials"    => [
@@ -34,10 +40,8 @@ makedocs(
                             ],
         "Applications" => [
                             "application-batch.md",
-                            "application-orbit.md",
                             "application-sail.md",
                             "Catenoid solution" => "application-surface-revolution.md",
-                            "MRI: saturation problem" => "application-mri-saturation.md",
                           ],
         "FGS 2024"     => "fgs-2024.md", 
         "JuliaCon 2024"=> "juliacon2024.md", 
diff --git a/docs/src/api-ctbase.md b/docs/src/api-ctbase.md
@@ -1,7 +1,7 @@
 # CTBase API
 
 This is just a dump of CTBase API documentation.
-For more details about `CTBase.jl` package, see the [documentation](https://control-toolbox.org/docs/ctbase).
+For more details about `CTBase.jl` package, see the [documentation](https://control-toolbox.org/CTBase.jl).
 
 ## Index
 
diff --git a/docs/src/api-ctdirect.md b/docs/src/api-ctdirect.md
@@ -1,7 +1,7 @@
 # CTDirect API
 
 This is just a dump of CTDirect API documentation.
-For more details about `CTDirect.jl` package, see the [documentation](https://control-toolbox.org/docs/ctdirect).
+For more details about `CTDirect.jl` package, see the [documentation](https://control-toolbox.org/CTDirect.jl).
 
 ## Index
 
diff --git a/docs/src/api-ctflows.md b/docs/src/api-ctflows.md
@@ -1,7 +1,7 @@
 # CTFlows API
 
 This is just a dump of CTFlows API documentation.
-For more details about `CTFlows.jl` package, see the [documentation](https://control-toolbox.org/docs/ctflows).
+For more details about `CTFlows.jl` package, see the [documentation](https://control-toolbox.org/CTFlows.jl).
 
 ## Index
 
diff --git a/docs/src/api-ctproblems.md b/docs/src/api-ctproblems.md
@@ -1,7 +1,7 @@
 # CTProblems API
 
 This is just a dump of CTProblems API documentation.
-For more details about `CTProblems.jl` package, see the [documentation](https://control-toolbox.org/docs/ctproblems).
+For more details about `CTProblems.jl` package, see the [documentation](https://control-toolbox.org/CTProblems.jl).
 
 ## Index
 
diff --git a/docs/src/application-mri-saturation.md b/docs/src/application-mri-saturation.md
diff --git a/docs/src/fgs-2024.md b/docs/src/fgs-2024.md
@@ -51,12 +51,12 @@ plus boundary, control and state constraints
 - New applications (biology, space mechanics, quantum mechanics and more)
 - Additional solvers: direct shooting, collocation for BVP, Hamiltonian pathfollowing...
 - ... and open to contributions!
-- [CTProblems.jl](https://control-toolbox.org/docs/ctproblems/stable/problems-list.html)
+- [CTProblems.jl](https://control-toolbox.org/CTProblems.jl/stable/problems-list.html)
 
 # control-toolbox.org
 
 - Open toolbox
-- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/docs/optimalcontrol)
+- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl)
 
 ```@raw html
 <a href="https://control-toolbox.org"><img width="800" alt="control-toolbox.org" src="./assets/control-toolbox.jpg"></a>
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -9,10 +9,10 @@ It is part of the [control-toolbox ecosystem](https://github.com/control-toolbox
 
 ```mermaid
 flowchart TD
-O(<a href='https://control-toolbox.org/docs/optimalcontrol/stable/'>OptimalControl</a>) --> B(<a href='https://control-toolbox.org/docs/ctbase/stable/'>CTBase</a>)
-O --> D(<a href='https://control-toolbox.org/docs/ctdirect/stable/'>CTDirect</a>)
-O --> F(<a href='https://control-toolbox.org/docs/ctflows/stable/'>CTFlows</a>)
-P(<a href='https://control-toolbox.org/docs/ctproblems/stable/'>CTProblems</a>) --> F
+O(<a href='https://control-toolbox.org/OptimalControl.jl/stable/'>OptimalControl</a>) --> B(<a href='https://control-toolbox.org/CTBase.jl/stable/'>CTBase</a>)
+O --> D(<a href='https://control-toolbox.org/CTDirect.jl/stable/'>CTDirect</a>)
+O --> F(<a href='https://control-toolbox.org/CTFlows.jl/stable/'>CTFlows</a>)
+P(<a href='https://control-toolbox.org/CTProblems.jl/stable/'>CTProblems</a>) --> F
 P --> B
 F --> B
 D --> B
diff --git a/docs/src/juliacon2023.md b/docs/src/juliacon2023.md
@@ -27,9 +27,9 @@ plus boundary, control and state constraints
 - [Coupling direct and indirect solvers, examples](https://ct.gitlabpages.inria.fr/gallery//notebooks.html)
 
 # OptimalControl.jl
-- [Basic example: double integrator](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-basic-example-f.html)
-- [Basic example: double integrator (cont'ed)](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-basic-example.html)
-- [Advanced example: Goddard problem](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-goddard.html)
+- [Basic example: double integrator](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-basic-example-f.html)
+- [Basic example: double integrator (cont'ed)](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-basic-example.html)
+- [Advanced example: Goddard problem](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-goddard.html)
 
 # Wrap up
 - [X] High level modelling of optimal control problems
@@ -40,11 +40,11 @@ plus boundary, control and state constraints
 - [ct_repl](./assets/repl.mp4)
 - Additional solvers: direct shooting, collocation for BVP, Hamiltonian pathfollowing...
 - ... and open to contributions!
-- [CTProblems.jl](https://control-toolbox.org/docs/ctproblems/stable/problems-list.html)
+- [CTProblems.jl](https://control-toolbox.org/CTProblems.jl/stable/problems-list.html)
 
 # control-toolbox.org
 - Open toolbox
-- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/docs/optimalcontrol)
+- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl)
 
 ```@raw html
 <a href="https://control-toolbox.org"><img width="800" alt="control-toolbox.org" src="./assets/control-toolbox.jpg"></a>
diff --git a/docs/src/juliacon2024.md b/docs/src/juliacon2024.md
@@ -50,7 +50,7 @@ plus boundary, control and state constraints
 ## control-toolbox.org
 
 - Open toolbox
-- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/docs/optimalcontrol)
+- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl)
 
 ```@raw html
 <a href="https://control-toolbox.org"><img width="800" alt="control-toolbox.org" src="./assets/control-toolbox.jpg"></a>
diff --git a/docs/src/juliaopt2023.md b/docs/src/juliaopt2023.md
@@ -36,11 +36,11 @@ plus boundary, control and state constraints
 
 # OptimalControl.jl
 
-- [Basic example: double integrator (1/3)](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-basic-example-f.html)
-- [Basic example: double integrator (2/3)](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-basic-example.html)
-- [Basic example: double integrator (3/3)](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-double-integrator.html)
-- [Indirect simple shooting](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-iss.html)
-- [Advanced example: Goddard problem](https://control-toolbox.org/docs/optimalcontrol/dev/tutorial-goddard.html)
+- [Basic example: double integrator (1/3)](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-basic-example-f.html)
+- [Basic example: double integrator (2/3)](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-basic-example.html)
+- [Basic example: double integrator (3/3)](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-double-integrator.html)
+- [Indirect simple shooting](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-iss.html)
+- [Advanced example: Goddard problem](https://control-toolbox.org/OptimalControl.jl/dev/tutorial-goddard.html)
 
 # Wrap up
 
@@ -53,12 +53,12 @@ plus boundary, control and state constraints
 - [ct_repl](./assets/repl.mp4)
 - Additional solvers: direct shooting, collocation for BVP, Hamiltonian pathfollowing...
 - ... and open to contributions!
-- [CTProblems.jl](https://control-toolbox.org/docs/ctproblems/stable/problems-list.html)
+- [CTProblems.jl](https://control-toolbox.org/CTProblems.jl/stable/problems-list.html)
 
 # control-toolbox.org
 
 - Open toolbox
-- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/docs/optimalcontrol)
+- Collection of Julia Packages rooted at [OptimalControl.jl](https://control-toolbox.org/OptimalControl.jl)
 
 ```@raw html
 <a href="https://control-toolbox.org"><img width="800" alt="control-toolbox.org" src="./assets/control-toolbox.jpg"></a>
diff --git a/docs/src/mri-resources/bloch.jpeg b/docs/src/mri-resources/bloch.jpeg
diff --git a/docs/src/mri-resources/invariance-proof.txt b/docs/src/mri-resources/invariance-proof.txt
diff --git a/docs/src/mri-resources/inversion_sequence.png b/docs/src/mri-resources/inversion_sequence.png
diff --git a/docs/src/mri-resources/mri.jpg b/docs/src/mri-resources/mri.jpg
diff --git a/docs/src/mri-resources/reduction-2D.txt b/docs/src/mri-resources/reduction-2D.txt
diff --git a/docs/src/mri-resources/spherical-coordinates.txt b/docs/src/mri-resources/spherical-coordinates.txt
diff --git a/docs/src/tutorial-basic-example-f.md b/docs/src/tutorial-basic-example-f.md
@@ -25,7 +25,7 @@ starting from the condition $x(0) = (-1, 0)$ and with the goal to reach the targ
 !!! note "Solution and details"
 
     See the page 
-    [Double integrator: energy minimisation](https://control-toolbox.org/docs/ctproblems/stable/problems/double_integrator_energy.html#DIE) 
+    [Double integrator: energy minimisation](https://control-toolbox.org/CTProblems.jl/stable/problems/double_integrator_energy.html#DIE) 
     for the analytical solution and details about this problem.
 
 First, we need to import the `OptimalControl.jl` package to define the optimal control problem and `NLPModelsIpopt.jl` to solve it. 
@@ -58,7 +58,7 @@ nothing # hide
 !!! note "Nota bene"
 
     There are two ways to define an optimal control problem:
-    - using functions like in this example, see also the [`Model` documentation](https://control-toolbox.org/docs/ctbase/stable/api-model.html) for more details.
+    - using functions like in this example, see also the [`Model` documentation](https://control-toolbox.org/CTBase.jl/stable/api-model.html) for more details.
     - using an abstract formulation, see for instance [basic example](@ref basic) to compare.
 
 Solve it
diff --git a/docs/src/tutorial-basic-example.md b/docs/src/tutorial-basic-example.md
@@ -25,7 +25,7 @@ starting from the condition $x(0) = (-1, 0)$ and with the goal to reach the targ
 !!! note "Solution and details"
 
     See the page 
-    [Double integrator: energy minimisation](https://control-toolbox.org/docs/ctproblems/stable/problems/double_integrator_energy.html#DIE) 
+    [Double integrator: energy minimisation](https://control-toolbox.org/CTProblems.jl/stable/problems/double_integrator_energy.html#DIE) 
     for the analytical solution and details about this problem.
 
 First, we need to import the `OptimalControl.jl` package to define the optimal control problem and `NLPModelsIpopt.jl` to solve it. 
diff --git a/docs/src/tutorial-goddard.md b/docs/src/tutorial-goddard.md
@@ -188,7 +188,7 @@ as well as the associated multiplier for the *order one* state constraint on the
     which is the reason why we use the `@Lie` macro to compute Poisson brackets below.
 
 With the help of the [differential geometry primitives](https://control-toolbox.org/CTBase.jl/stable/api-diffgeom.html)
-from [CTBase.jl](https://control-toolbox.org/docs/ctbase),
+from [CTBase.jl](https://control-toolbox.org/CTBase.jl),
 these expressions are straightforwardly translated into Julia code:
 
 ```@example main
diff --git a/docs/src/tutorial-lqr-basic.md b/docs/src/tutorial-lqr-basic.md
@@ -76,7 +76,7 @@ end
 nothing # hide
 ```
 
-We plot the state and control variables considering a normalized time $s=(t-t_0)/(t_f-t_0)$, thanks to the keyword argument `time=:normalized` of the [plot](https://control-toolbox.org/docs/ctbase/stable/api-plot.html) function.
+We plot the state and control variables considering a normalized time $s=(t-t_0)/(t_f-t_0)$, thanks to the keyword argument `time=:normalized` of the [plot](https://control-toolbox.org/CTBase.jl/stable/api-plot.html) function.
 
 ```@example main
 plt = plot(solutions[1], time=:normalized)
diff --git a/docs/src/tutorial-plot.md b/docs/src/tutorial-plot.md
@@ -113,7 +113,7 @@ plot!(plt, sol2, solution_label="(sol2)", linestyle=:dash)
 
 ## Plot the norm of the control
 
-For some problem, it is interesting to plot the norm of the control. You can do it by using the `control` optional keyword argument with `:norm` value. The default value is `:components`. Let us illustrate this on the consumption minimisation orbital transfer problem from [CTProlbems.jl](https://control-toolbox.org/docs/ctproblems).
+For some problem, it is interesting to plot the norm of the control. You can do it by using the `control` optional keyword argument with `:norm` value. The default value is `:components`. Let us illustrate this on the consumption minimisation orbital transfer problem from [CTProlbems.jl](https://control-toolbox.org/CTProblems.jl).
 
 ```@example main
 using CTProblems
@@ -144,7 +144,7 @@ plot(t, norm∘u, label="‖u‖")
 ## Normalized time
 
 We consider a [LQR example](@ref) and solve the problem for different values of the final time `tf`.
-Then, we plot the solutions on the same figure considering a normalized time $s=(t-t_0)/(t_f-t_0)$, thanks to the keyword argument `time=:normalized` of the [plot](https://control-toolbox.org/docs/ctbase/stable/api-plot.html) function.
+Then, we plot the solutions on the same figure considering a normalized time $s=(t-t_0)/(t_f-t_0)$, thanks to the keyword argument `time=:normalized` of the [plot](https://control-toolbox.org/CTBase.jl/stable/api-plot.html) function.
 
 ```@example main
 
