brocksam · jtheinen · Jun 27, 2023 · Jun 28, 2023 · Jun 28, 2023 · Jun 28, 2023
diff --git a/docs/_autosummary/pycollo.optimal_control_problem.OptimalControlProblem.rst b/docs/_autosummary/pycollo.optimal_control_problem.OptimalControlProblem.rst
@@ -0,0 +1,55 @@
+..
+  class.rst
+
+pycollo.optimal\_control\_problem.OptimalControlProblem
+=======================================================
+
+.. currentmodule:: pycollo.optimal_control_problem
+
+.. autoclass:: OptimalControlProblem
+    :members:
+    :show-inheritance:
+    :inherited-members:
+    :special-members:
+    :exclude-members: __weakref__
+
+
+
+            .. rubric:: Attributes
+
+            .. autosummary::
+
+                    ~OptimalControlProblem.auxiliary_data
+                    ~OptimalControlProblem.bounds
+                    ~OptimalControlProblem.endpoint_constraints
+                    ~OptimalControlProblem.guess
+                    ~OptimalControlProblem.mesh_iterations
+                    ~OptimalControlProblem.name
+                    ~OptimalControlProblem.num_mesh_iterations
+                    ~OptimalControlProblem.number_endpoint_constraints
+                    ~OptimalControlProblem.number_parameter_variables
+                    ~OptimalControlProblem.number_phases
+                    ~OptimalControlProblem.objective_function
+                    ~OptimalControlProblem.parameter_variables
+                    ~OptimalControlProblem.phases
+                    ~OptimalControlProblem.scaling
+                    ~OptimalControlProblem.settings
+                    ~OptimalControlProblem.solution
+                    ~OptimalControlProblem.time_symbol
+
+
+            .. rubric:: Methods
+
+            .. autosummary::
+                :nosignatures:
+
+                    ~OptimalControlProblem.__init__
+                    ~OptimalControlProblem.add_phase
+                    ~OptimalControlProblem.add_phases
+                    ~OptimalControlProblem.initialise
+                    ~OptimalControlProblem.new_phase
+                    ~OptimalControlProblem.new_phase_like
+                    ~OptimalControlProblem.new_phases_like
+                    ~OptimalControlProblem.solve
+
+
diff --git a/docs/_autosummary/pycollo.optimal_control_problem.cout.rst b/docs/_autosummary/pycollo.optimal_control_problem.cout.rst
@@ -0,0 +1,9 @@
+..
+  base.rst
+
+pycollo.optimal\_control\_problem.cout
+======================================
+
+.. currentmodule:: pycollo.optimal_control_problem
+
+.. autofunction:: cout
diff --git a/docs/_autosummary/pycollo.optimal_control_problem.kill.rst b/docs/_autosummary/pycollo.optimal_control_problem.kill.rst
@@ -0,0 +1,9 @@
+..
+  base.rst
+
+pycollo.optimal\_control\_problem.kill
+======================================
+
+.. currentmodule:: pycollo.optimal_control_problem
+
+.. autofunction:: kill
diff --git a/docs/_autosummary/pycollo.optimal_control_problem.rst b/docs/_autosummary/pycollo.optimal_control_problem.rst
@@ -0,0 +1,45 @@
+..
+  module.rst
+
+pycollo.optimal\_control\_problem
+=================================
+
+.. automodule:: pycollo.optimal_control_problem
+
+
+
+
+
+
+
+            .. rubric:: Functions
+
+            .. autosummary::
+                :toctree:
+                :nosignatures:
+                :template: autosummary/base.rst
+
+                    cout
+                    kill
+
+
+
+
+
+            .. rubric:: Classes
+
+            .. autosummary::
+                :toctree:
+                :nosignatures:
+                :template: autosummary/class.rst
+
+                    OptimalControlProblem
+
+
+
+
+
+
+
+
+
diff --git a/docs/_autosummary/pycollo.phase.Phase.rst b/docs/_autosummary/pycollo.phase.Phase.rst
@@ -0,0 +1,57 @@
+..
+  class.rst
+
+pycollo.phase.Phase
+===================
+
+.. currentmodule:: pycollo.phase
+
+.. autoclass:: Phase
+    :members:
+    :show-inheritance:
+    :inherited-members:
+    :special-members:
+    :exclude-members: __weakref__
+
+
+
+            .. rubric:: Attributes
+
+            .. autosummary::
+
+                    ~Phase.bounds
+                    ~Phase.control_variables
+                    ~Phase.final_state_variables
+                    ~Phase.final_time_variable
+                    ~Phase.guess
+                    ~Phase.initial_state_variables
+                    ~Phase.initial_time_variable
+                    ~Phase.integral_variables
+                    ~Phase.integrand_functions
+                    ~Phase.mesh
+                    ~Phase.name
+                    ~Phase.number_control_variables
+                    ~Phase.number_integral_variables
+                    ~Phase.number_integrand_functions
+                    ~Phase.number_path_constraints
+                    ~Phase.number_state_equations
+                    ~Phase.number_state_variables
+                    ~Phase.optimal_control_problem
+                    ~Phase.path_constraints
+                    ~Phase.phase_number
+                    ~Phase.scaling
+                    ~Phase.state_equations
+                    ~Phase.state_variables
+                    ~Phase.time_variables
+
+
+            .. rubric:: Methods
+
+            .. autosummary::
+                :nosignatures:
+
+                    ~Phase.__init__
+                    ~Phase.create_new_copy
+                    ~Phase.create_new_copy_like
+
+
diff --git a/docs/_autosummary/pycollo.phase.rst b/docs/_autosummary/pycollo.phase.rst
@@ -0,0 +1,35 @@
+..
+  module.rst
+
+pycollo.phase
+=============
+
+.. automodule:: pycollo.phase
+
+
+
+
+
+
+
+
+
+
+
+            .. rubric:: Classes
+
+            .. autosummary::
+                :toctree:
+                :nosignatures:
+                :template: autosummary/class.rst
+
+                    Phase
+
+
+
+
+
+
+
+
+
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -10,6 +10,7 @@
     :show-inheritance:
     :inherited-members:
     :special-members:
+    :exclude-members: __weakref__, __repr__, __str__
 
     {% block methods %}
         {% if methods %}

diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -4,10 +4,12 @@
 API Reference
 =============
 
+.. image:: code_structure.png
+  :width: 800
+
 .. autosummary::
    :toctree: _autosummary
    :recursive:
 
     pycollo.optimal_control_problem
     pycollo.phase
-
diff --git a/docs/code_structure.png b/docs/code_structure.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,6 +24,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.autosummary",
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
@@ -45,7 +46,6 @@
     "python": ("http://docs.python.org/3", None),
 }
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output