up doc

Author: ocots

Project.toml

@@ -1,7 +1,7 @@
 name = "CTModels"
 uuid = "34c4fa32-2049-4079-8329-de33c2a22e2d"
 authors = ["Olivier Cots <olivier.cots@toulouse-inp.fr>"]
-version = "0.5.1"
+version = "0.5.2"
 
 [deps]
 CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"

docs/Project.toml

@@ -1,8 +1,12 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
+JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 
 [compat]
 Documenter = "1"
+JLD2 = "0.5"
+JSON3 = "1.14"
 Plots = "1.40"
 julia = "1.10"

docs/make.jl

@@ -1,9 +1,15 @@
 using Documenter
 using CTModels
 using Plots
+using JSON3
+using JLD2
+
+const CTModelsPlots = Base.get_extension(CTModels, :CTModelsPlots)
+const CTModelsJSON = Base.get_extension(CTModels, :CTModelsJSON)
+const CTModelsJLD = Base.get_extension(CTModels, :CTModelsJLD)
 
 # to add docstrings from external packages
-Modules = [Plots]
+Modules = [Plots, CTModelsPlots, CTModelsJSON, CTModelsJLD]
 for Module in Modules
     isnothing(DocMeta.getdocmeta(Module, :DocTestSetup)) &&
         DocMeta.setdocmeta!(Module, :DocTestSetup, :(using $Module); recursive=true)
@@ -24,7 +30,32 @@ makedocs(;
             asset("https://control-toolbox.org/assets/js/documentation.js"),
         ],
     ),
-    pages=["Introduction" => "index.md", "Developers" => "dev.md"],
+    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",
+            ]
+        ],
     checkdocs=:none,
 )
 

docs/src/constraints.md

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

docs/src/control.md

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

docs/src/ctmodels.md

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

docs/src/default.md

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

docs/src/definition.md

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

docs/src/dev.md

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