up doc

Author: ocots

docs/make.jl

@@ -17,6 +17,30 @@ end
 
 repo_url = "github.com/control-toolbox/CTModels.jl"
 
+API_PAGES = [
+    "constraints.md",
+    "control.md",
+    "ctmodels.md",
+    "default.md",
+    "definition.md",
+    "dual_model.md",
+    "dynamics.md",
+    "init.md",
+    "jld.md",
+    "json.md",
+    "model.md",
+    "objective.md",
+    "plot.md",
+    "print.md",
+    "solution.md",
+    "state.md",
+    "time_dependence.md",
+    "times.md",
+    "types.md",
+    "utils.md",
+    "variable.md"
+]
+
 makedocs(;
     remotes=nothing,
     warnonly=[:cross_references, :autodocs_block],
@@ -32,29 +56,7 @@ makedocs(;
     ),
     pages=[
         "Introduction" => "index.md", 
-        "API" => [
-            "constraints.md",
-            "control.md",
-            "ctmodels.md",
-            "default.md",
-            "definition.md",
-            "dual_model.md",
-            "dynamics.md",
-            "init.md",
-            "jld.md",
-            "json.md",
-            "model.md",
-            "objective.md",
-            "plot.md",
-            "print.md",
-            "solution.md",
-            "state.md",
-            "time_dependence.md",
-            "times.md",
-            "types.md",
-            "utils.md",
-            "variable.md",
-            ]
+        "API" => API_PAGES,
         ],
     checkdocs=:none,
 )

docs/src/constraints.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["constraints.md"]
-Modules = [CTModels]
+Modules = [CTModels, Base]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

docs/src/ctmodels.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["ctmodels.md"]
-Modules = [CTModels]
+Modules = [CTModels, RecipesBase]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

docs/src/index.md

@@ -2,4 +2,11 @@
 
 The `CTModels.jl` package is part of the [control-toolbox ecosystem](https://github.com/control-toolbox).
 
-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.
+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.
+
+**API Documentation**
+
+```@contents
+Pages = Main.API_PAGES
+Depth = 1
+```

docs/src/jld.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["jld.md"]
-Modules = [CTModelsJLD]
+Modules = [CTModels, CTModelsJLD]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

docs/src/json.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["json.md"]
-Modules = [CTModelsJSON]
+Modules = [CTModels, CTModelsJSON]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

docs/src/plot.md

@@ -10,10 +10,6 @@ Order = [:module, :constant, :type, :function, :macro]
 
 ## Documentation
 
-```@docs
-plot(::CTModels.Solution, ::Symbol...)
-```
-
 ```@autodocs
 Modules = [CTModelsPlots]
 Order = [:module, :constant, :type, :function, :macro]

docs/src/print.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["print.md"]
-Modules = [CTModels]
+Modules = [CTModels, Base]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

docs/src/solution.md

@@ -4,7 +4,7 @@
 
 ```@index
 Pages   = ["solution.md"]
-Modules = [CTModels]
+Modules = [CTModels, Base]
 Order = [:module, :constant, :type, :function, :macro]
 ```
 

src/time_dependence.jl

@@ -1,14 +1,50 @@
-function time_dependence!(ocp::PreModel; autonomous::Bool)::Nothing
+"""
+$(TYPEDSIGNATURES)
+
+Set the time dependence of the optimal control problem `ocp`.
+
+# Arguments
+- `ocp::PreModel`: The optimal control problem being defined.
+- `autonomous::Bool`: Indicates whether the system is autonomous (`true`) or time-dependent (`false`).
+
+# Preconditions
+- The time dependence must not have been set previously.
 
-    # checkings
+# Behavior
+This function sets the `autonomous` field of the model to indicate whether the system's dynamics
+explicitly depend on time. It can only be called once.
+
+# Errors
+Throws `CTBase.UnauthorizedCall` if the time dependence has already been set.
+
+# Example
+```julia-repl
+julia> ocp = PreModel(...)
+julia> time_dependence!(ocp; autonomous=true)
+```
+"""
+function time_dependence!(ocp::PreModel; autonomous::Bool)::Nothing
     @ensure !__is_autonomous_set(ocp) CTBase.UnauthorizedCall(
         "the time dependence has already been set."
     )
-
-    # set the state
     ocp.autonomous = autonomous
-
     return nothing
 end
 
+"""
+$(TYPEDSIGNATURES)
+
+Check whether the system is autonomous.
+
+# Arguments
+- `ocp::PreModel`: The optimal control problem.
+
+# Returns
+- `Bool`: `true` if the system is autonomous (i.e., does not explicitly depend on time), `false` otherwise.
+
+# Example
+```julia-repl
+julia> is_autonomous(ocp)  # returns true or false
+```
+"""
 is_autonomous(ocp::PreModel) = ocp.autonomous