Merge pull request #508 from control-toolbox/507-doc-solve-function

tuto solve: arguments details

Author: ocots

docs/src/index.md

@@ -73,3 +73,67 @@ If you want to ask a question, feel free to start a discussion [here](https://gi
 !!! note
 
     If you want to add an application or a package to the control-toolbox ecosystem, please follow this [set up tutorial](https://github.com/control-toolbox/CTApp.jl/discussions/9).
+
+## Reproducibility
+
+```@raw html
+<details><summary>The documentation of this package was built using these direct dependencies,</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>and using this machine and Julia version.</summary>
+```
+
+```@example
+using InteractiveUtils # hide
+versioninfo() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status(; mode = PKGMODE_MANIFEST) # hide
+```
+
+```@raw html
+</details>
+```
+
+```@eval
+using TOML
+using Markdown
+version = TOML.parse(read("../../Project.toml", String))["version"]
+name = TOML.parse(read("../../Project.toml", String))["name"]
+link_manifest = "https://github.com/SciML/" *
+                name *
+                ".jl/tree/gh-pages/v" *
+                version *
+                "/assets/Manifest.toml"
+link_project = "https://github.com/SciML/" *
+               name *
+               ".jl/tree/gh-pages/v" *
+               version *
+               "/assets/Project.toml"
+Markdown.parse("""You can also download the
+[manifest]($link_manifest)
+file and the
+[project]($link_project)
+file.
+""")
+```

docs/src/tutorial-solve.md

@@ -99,9 +99,11 @@ solve(ocp, :direct, :adnlp, :ipopt)
 
 The options for the direct method are listed [here](https://control-toolbox.org/OptimalControl.jl/stable/dev-ctdirect.html#CTDirect.solve-Tuple{Model,%20Vararg{Symbol}}). The main options, with their [default values], are:
 - `display` ([true], false): setting `display` to false will disable output.
+- `init`: info for the starting guess, which can be provided as numerical values, functions, or an existing solution. See [initial guess tutorial](@ref tutorial-initial-guess).
 - `grid_size` ([250]): size of the (uniform) time discretization grid. More precisely, it is the number of time steps, that is if `N = grid_size` and if the initial and final times are denoted respectively `t0` and `tf`, then we have `Δt = (tf - t0) / N`.
+- `time_grid` ([`nothing`]): explicit time grid (can be non uniform). If `time_grid` is nothing then, a uniform grid is built of length `grid_size`.
 - `disc_method` ([`:trapeze`], `:midpoint`, `:euler`, `:euler_implicit`, `:gauss_legendre_2`, `:gauss_legendre_3`): see [discretisation methods](https://control-toolbox.org/Tutorials.jl/stable/tutorial-discretisation.html).
-- `init`: info for the starting guess, which can be provided as numerical values, functions, or an existing solution. See [initial guess tutorial](@ref tutorial-initial-guess). 
+- `adnlp_backend`: backend for automatic differentiation in ADNLPModels ([`:optimized`], `:manual`, `:default`).
 
 For examples of more advanced use, see 
 - [discrete continuation](https://control-toolbox.org/Tutorials.jl/stable/tutorial-continuation.html),
@@ -114,12 +116,12 @@ In addition to these options, all remaining keyword arguments passed to `solve`
 
 Please check the list of [Ipopt options](https://coin-or.github.io/Ipopt/OPTIONS.html) and the [NLPModelsIpopt.jl documentation](https://jso.dev/NLPModelsIpopt.jl).
 ```@example main
-solve(ocp; max_iter=0)
-nothing # hide
+sol = solve(ocp; max_iter=0, display=false)
+iterations(sol)
 ```
 
 Similarly, please check the [MadNLP.jl documentation](https://madnlp.github.io/MadNLP.jl) and the list of [MadNLP.jl options](https://madnlp.github.io/MadNLP.jl/stable/options/).
 ```@example main
-solve(ocp, :madnlp; max_iter=0)
-nothing # hide
+sol = solve(ocp, :madnlp; max_iter=0, display=false)
+iterations(sol)
 ```