re-structuring

Author: e-duar-do

Project.toml

@@ -8,7 +8,7 @@ MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
 
 [compat]
 julia = "1.6"
-MathOptInterface = "1.30"
+MathOptInterface = "1.31"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

docs/make.jl

@@ -6,19 +6,24 @@ using DocumenterMermaid
 DocMeta.setdocmeta!(DynOptInterface, :DocTestSetup, :(import DynOptInterface as DOI); recursive=true)
 
 const _PAGES = [
-    "Home" => "index.md",
+    #"Home" => "index.md",
     "API Reference" => [
-        "reference/phases.md",
-        "reference/dynamic_variables.md",
-        "reference/dynamic_functions.md",
+        "Dynamic Functions" => [
+            "reference/dynamic_functions/abstraction.md",
+            "reference/dynamic_functions/phases.md",
+            "reference/dynamic_functions/dynamic_variables.md",
+            "reference/dynamic_functions/expressions.md",
+            "reference/dynamic_functions/derivatives.md",
+        ],
         "reference/boundary_functions.md",
-        "reference/integral_functions.md",
         "reference/nonlinear_support.md",
+        "reference/attributes.md",
+        "reference/solutions.md",
     ],
 ]
 
 links = InterLinks(
-    "MathOptInterface" => "https://jump.dev/MathOptInterface.jl/v1.30/objects.inv"
+    "MathOptInterface" => "https://jump.dev/MathOptInterface.jl/v1.31/objects.inv"
 )
 
 makedocs(;

docs/src/reference/attributes.md

@@ -0,0 +1,22 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Attributes
+
+# Variable Attributes
+
+The following table defines which `DynOptInterface` objects are compatible with sub-types of
+[`MOI.AbstractVariableAttribute`](@extref MathOptInterface.AbstractVariableAttribute)s.
+
+| Attribute | ``t`` | ``t^0`` | ``t^f`` | ``y(\cdot)`` | ``y(t^0)`` | ``y(t^f)`` |
+|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
+| [`MOI.VariableName`](@extref MathOptInterface.VariableName) | ✅ | ❌ | ❌ | ✅ | ❌ | ❌ |
+| [`MOI.VariablePrimal`](@extref MathOptInterface.VariablePrimal) | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| [`MOI.VariablePrimalStart`](@extref MathOptInterface.VariablePrimalStart) | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
+```@docs
+MOI.supports
+MOI.set
+MOI.get
+```

docs/src/reference/boundary_functions.md

@@ -4,9 +4,33 @@ CurrentModule = DynOptInterface
 
 # Boundary Functions
 
+## Abstraction
+
 ```@docs
 AbstractBoundaryFunction
+```
+
+## Initial & Final
+
+```@docs
 Initial
 Final
+```
+
+## Linkage
+
+```@docs
+Linkage
+```
+
+## Nonlinear
+
+```@docs
 NonlinearBoundaryFunction
+```
+
+## Integrals
+```@docs
+Integral
+Bolza
 ```

docs/src/reference/dynamic_functions/abstraction.md

@@ -0,0 +1,11 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Abstraction
+
+```@docs
+AbstractDynamicFunction
+phase_index
+MixedPhases
+```

docs/src/reference/dynamic_functions/derivatives.md

@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Derivatives
+
+```@docs
+DynamicVariableDerivative
+ExplicitDifferentialFunction
+```

docs/src/reference/dynamic_functions/dynamic_variables.md

@@ -0,0 +1,13 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Dynamic Variables
+
+```@docs
+DynamicVariableIndex
+supports_dynamic_variable
+UnsupportedDynamicVariable
+add_dynamic_variable
+AddDynamicVariableNotAllowed
+```

docs/src/reference/dynamic_functions.md renamed to docs/src/reference/dynamic_functions/expressions.md

@@ -2,13 +2,22 @@
 CurrentModule = DynOptInterface
 ```
 
-# Dynamic Functions
+# Expressions
+
+## Linear
 
 ```@docs
 LinearDynamicTerm
 LinearDynamicFunction
+```
+
+## Squared
+```@docs
 SquaredDynamicTerm
 SquaredDynamicFunction
+```
+
+## Nonlinear
+```@docs
 NonlinearDynamicFunction
-ExplicitDifferentialFunction
 ```

docs/src/reference/dynamic_functions/phases.md

@@ -0,0 +1,13 @@
+```@meta
+CurrentModule = DynOptInterface
+```
+
+# Phases
+
+```@docs
+PhaseIndex
+supports_phase
+UnsupportedPhase
+AddPhaseNotAllowed
+add_phase
+```