Merge branch 'main' of github.com:control-toolbox/CTModels.jl

Author: ocots

Project.toml

@@ -24,7 +24,7 @@ CTModelsExportImport = ["JLD2", "JSON3"]
 CTModelsPlots = "Plots"
 
 [compat]
-CTBase = "0.15"
+CTBase = "0.16"
 DocStringExtensions = "0.9"
 Interpolations = "0.15"
 JLD2 = "0.5"

docs/make.jl

@@ -16,7 +16,7 @@ makedocs(;
             asset("https://control-toolbox.org/assets/js/documentation.js"),
         ],
     ),
-    pages=["Introduction" => "index.md", "API" => "api.md"],
+    pages=["Introduction" => "index.md", "Developers" => "dev.md"],
     checkdocs=:none,
 )
 

docs/src/api.md

@@ -0,0 +1,32 @@
+# Private functions
+
+```@meta
+CollapsedDocStrings = false
+CurrentModule =  CTModels
+```
+
+## CTModels 
+
+```@autodocs
+Modules = [CTModels]
+Order   = [:module]
+Pages   = ["CTModels.jl"]
+Private = false
+```
+
+## Index
+
+```@index
+Pages   = ["dev.md"]
+Modules = [CTModels]
+Order   = [:constant, :type, :function, :macro]
+```
+
+## Documentation
+
+```@autodocs
+Modules = [CTModels]
+Order   = [:constant, :type, :function, :macro]
+Public  = false
+```
+

docs/src/dev.md

@@ -1,12 +1,5 @@
-# CTModels
+# CTModels.jl
 
-Documentation for [CTModels](https://github.com/control-toolbox/CTModels.jl).
+The `CTModels.jl` package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
 
-## Dependencies
-
-All the numerical simulations to generate this documentation are performed with the following packages.
-
-```@example
-using Pkg
-Pkg.status()
-```
+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.

docs/src/index.md

@@ -1,3 +1,10 @@
+"""
+[`CTModels`](@ref) module.
+
+Lists all the imported modules and packages:
+
+$(IMPORTS)
+"""
 module CTModels
 
 # imports

src/CTModels.jl

@@ -2,6 +2,44 @@
 $(TYPEDSIGNATURES)
 
 Add a constraint to a dictionary of constraints.
+
+## Arguments
+
+- `ocp_constraints`: The dictionary of constraints to which the constraint will be added.
+- `type`: The type of the constraint. It can be :state, :control, :variable, :boundary or :path.
+- `n`: The dimension of the state.
+- `m`: The dimension of the control.
+- `q`: The dimension of the variable.
+- `rg`: The range of the constraint. It can be an integer or a range of integers.
+- `f`: The function that defines the constraint. It must return a vector of the same dimension as the constraint.
+- `lb`: The lower bound of the constraint. It can be a number or a vector.
+- `ub`: The upper bound of the constraint. It can be a number or a vector.
+- `label`: The label of the constraint. It must be unique in the dictionary of constraints.
+
+## Requirements
+
+- The constraint must not be set before.
+- The lower bound `lb` and the upper bound `ub` cannot be both nothing.
+- The lower bound `lb` and the upper bound `ub` must have the same length, if both provided.
+
+If `rg` and `f` are not provided then, 
+
+- `type` must be :state, :control or :variable
+- `lb` and `ub` must be of dimension n, m or q respectively, when provided.
+
+If `rg` is provided, then:
+
+- `f` must not be provided.
+- `type` must be :state, :control or :variable.
+- `rg` must be a range of integers, and must be contained in 1:n, 1:m or 1:q respectively.
+
+If `f` is provided, then:
+
+- `rg` must not be provided.
+- `type` must be :boundary or :path.
+- `f` must be a function that returns a vector of the same dimension as the constraint.
+- `lb` and `ub` must be of the same dimension as the output of `f`, when provided.
+
 """
 function __constraint!(
     ocp_constraints::ConstraintsDictType,
@@ -124,7 +162,7 @@ end
 """
 $(TYPEDSIGNATURES)
 
-Add a constraint to a pre-model.
+Add a constraint to a pre-model. See `[__constraint!](@ref)` for more details.
 """
 function constraint!(
     ocp::PreModel,

src/constraints.jl

@@ -8,7 +8,7 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
 Aqua = "0.8"
-CTBase = "0.15"
-JSON3 = "1"
+CTBase = "0.16"
 JLD2 = "0.5"
-Plots = "1.40"
+JSON3 = "1"
+Plots = "1.40"