Merge pull request #413 from control-toolbox/412-doc-up-doc

up doc

Author: ocots

Project.toml

@@ -1,7 +1,7 @@
 name = "CTDirect"
 uuid = "790bbbee-bee9-49ee-8912-a9de031322d5"
 authors = ["Pierre Martinon <pierrecmartinon@gmail.com>"]
-version = "0.14.12"
+version = "0.14.13"
 
 [deps]
 ADNLPModels = "54578032-b7ea-4c30-94aa-7cbd1cce6c9a"

docs/Project.toml

@@ -1,9 +1,10 @@
 [deps]
-CTDirect = "790bbbee-bee9-49ee-8912-a9de031322d5"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
+MadNLP = "2621e9c9-9eb4-46b1-8089-e8c72242dfb6"
+NLPModelsIpopt = "f4238b75-b362-5c4c-b852-0801c9a21d71"
+NLPModelsKnitro = "bec4dd0d-7755-52d5-9a02-22f0ffc7efcb"
 
 [compat]
-CTDirect = "0.14"
 Documenter = "1"
 DocumenterMermaid = "0.2"

docs/make.jl

@@ -1,27 +1,55 @@
 using Documenter
 using DocumenterMermaid
-
 using CTDirect
+using NLPModelsIpopt
+using NLPModelsKnitro
+using MadNLP
 
 # to add docstrings from external packages
-DocMeta.setdocmeta!(CTDirect, :DocTestSetup, :(using CTDirect); recursive=true)
+const CTSolveExtIpopt = Base.get_extension(CTDirect, :CTSolveExtIpopt)
+const CTSolveExtKnitro = Base.get_extension(CTDirect, :CTSolveExtKnitro)
+const CTSolveExtMadNLP = Base.get_extension(CTDirect, :CTSolveExtMadNLP)
+Modules = [
+    CTSolveExtIpopt,
+    CTSolveExtKnitro,
+    CTSolveExtMadNLP,
+]
+for Module in Modules
+    isnothing(DocMeta.getdocmeta(Module, :DocTestSetup)) &&
+        DocMeta.setdocmeta!(Module, :DocTestSetup, :(using $Module); recursive=true)
+end
 
 repo_url = "github.com/control-toolbox/CTDirect.jl"
 
+API_PAGES = [
+    "common.md",
+    "ctsolveext_ipopt.md",
+    "ctsolveext_knitro.md",
+    "ctsolveext_madnlp.md",
+    "default.md",
+    "docp.md",
+    "euler.md",
+    "irk.md",
+    "midpoint.md",
+    "solution.md",
+    "solve.md",
+    "trapeze.md",
+]
+
 makedocs(;
     warnonly=[:cross_references, :autodocs_block],
     sitename="CTDirect.jl",
     format=Documenter.HTML(
-        repolink="https://"*repo_url,
+        repolink="https://" * repo_url,
         prettyurls=false,
         assets=[
             asset("https://control-toolbox.org/assets/css/documentation.css"),
             asset("https://control-toolbox.org/assets/js/documentation.js"),
         ],
     ),
-    pages=["Introduction" => "index.md", "API" => "api.md", "Developers" => "dev-api.md"],
+    pages=["Introduction" => "index.md", "API" => API_PAGES],
 )
 
 deploydocs(;
-    repo=repo_url*".git", devbranch="main"
+    repo=repo_url * ".git", devbranch="main"
 )

docs/src/assets/diagram.png

@@ -0,0 +1,17 @@
+# Common
+
+## Index
+
+```@index
+Pages   = ["common.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["common.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/assets/goddard.png

@@ -0,0 +1,17 @@
+# CTSolveExtIpopt
+
+## Index
+
+```@index
+Pages   = ["ctsolveext_ipopt.md"]
+Modules = [CTDirect, CTSolveExtIpopt]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["CTSolveExtIpopt.jl"]
+Modules = [CTSolveExtIpopt]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/common.md

@@ -0,0 +1,17 @@
+# CTSolveExtKnitro
+
+## Index
+
+```@index
+Pages   = ["ctsolveext_knitro.md"]
+Modules = [CTDirect, CTSolveExtKnitro]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["CTSolveExtKnitro.jl"]
+Modules = [CTSolveExtKnitro]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/ctsolveext_ipopt.md

@@ -0,0 +1,17 @@
+# CTSolveExtMadNLP
+
+## Index
+
+```@index
+Pages   = ["ctsolveext_madnlp.md"]
+Modules = [CTDirect, CTSolveExtMadNLP]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["CTSolveExtMadNLP.jl"]
+Modules = [CTSolveExtMadNLP]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/ctsolveext_knitro.md

@@ -0,0 +1,17 @@
+# Default
+
+## Index
+
+```@index
+Pages   = ["default.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["default.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/ctsolveext_madnlp.md

@@ -1,17 +1,17 @@
-# CTDirect API
+# DOCP
 
 ## Index
 
 ```@index
-Pages   = ["api.md"]
+Pages   = ["docp.md"]
 Modules = [CTDirect]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 
 ## Documentation
 
 ```@autodocs
+Pages = ["docp.jl"]
 Modules = [CTDirect]
 Order = [:module, :constant, :type, :function, :macro]
-Private = false
-```
+```

docs/src/default.md

@@ -0,0 +1,17 @@
+# Euler
+
+## Index
+
+```@index
+Pages   = ["euler.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["euler.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/dev-api.md

@@ -3,35 +3,20 @@
 ```@meta
 CurrentModule =  CTDirect
 ```
+The `CTDirect.jl` package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
 
-The [CTDirect.jl](control-toolbox.org/CTDirect.jl) package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
-
-```mermaid
-flowchart TD
-B(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctbase.html'>CTBase</a>)
-M(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctmodels.html'>CTModels</a>)
-P(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctparser.html'>CTParser</a>)
-O(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-optimalcontrol.html'>OptimalControl</a>)
-D(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctdirect.html'>CTDirect</a>)
-F(<a href='https://control-toolbox.org/OptimalControl.jl/stable/api-ctflows.html'>CTFlows</a>)
-O --> D
-O --> M
-O --> F
-O --> P
-F --> M
-O --> B
-F --> B
-D --> B
-D --> M
-P --> B
-M --> B
-style D fill:#FBF275
-```
+The root package is [OptimalControl.jl](https://github.com/control-toolbox/OptimalControl.jl) which aims to provide tools to model and solve optimal control problems with ordinary differential equations by direct and indirect methods.
+
+To install a package from the control-toolbox ecosystem, please visit the [installation page](https://github.com/control-toolbox#installation).
 
-!!! note "Install"
+## API Documentation
+
+```@contents
+Pages = Main.API_PAGES
+Depth = 1
+```
 
-    To install a package from the control-toolbox ecosystem, 
-    please visit the [installation page](https://github.com/control-toolbox#installation).
+## Brief Overview
 
 An optimal control problem with fixed initial and final times, denoted (OCP), can be described as minimising the cost functional
 
@@ -94,7 +79,7 @@ LB \le C(X) \le UB
 
 Solving the (NLP) problem is done using packages from [JuliaSmoothOptimizers](https://github.com/JuliaSmoothOptimizers), with Ipopt as the default solver.
 
-On the input side of this package, we use an [`OptimalControlModel`](@ref) structure from CTModels to define the (OCP).
+On the input side of this package, we use a `Model` structure from CTModels to define the (OCP).
 
 The direct transcription to build the (NLP) can use discretization schemes such as trapeze (default), midpoint, or Gauss-Legendre collocations.
 

docs/src/api.md renamed to docs/src/docp.md

@@ -0,0 +1,17 @@
+# IRK
+
+## Index
+
+```@index
+Pages   = ["irk.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["irk.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/euler.md

@@ -0,0 +1,17 @@
+# Midpoint
+
+## Index
+
+```@index
+Pages   = ["midpoint.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["midpoint.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/index.md

@@ -0,0 +1,17 @@
+# Solution
+
+## Index
+
+```@index
+Pages   = ["solution.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["solution.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/irk.md

@@ -0,0 +1,17 @@
+# Solve
+
+## Index
+
+```@index
+Pages   = ["solve.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["solve.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/midpoint.md

@@ -0,0 +1,17 @@
+# Trapeze
+
+## Index
+
+```@index
+Pages   = ["trapeze.md"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Pages = ["trapeze.jl"]
+Modules = [CTDirect]
+Order = [:module, :constant, :type, :function, :macro]
+```

docs/src/solution.md

@@ -1,9 +1,7 @@
 module CTDirect
 
 import CTModels
-
 using ADNLPModels
-
 using DocStringExtensions
 using SparseArrays