Update full package reference to include optimizers

mggg · May 24, 2024 · 9c7afd6 · 9c7afd6
1 parent d895b7a
commit 9c7afd6
Showing 1 changed file with 45 additions and 27 deletions.
diff --git a/docs/full_ref.rst b/docs/full_ref.rst
@@ -27,33 +27,6 @@ Chain
     :show-inheritance:
     :noindex:
 
-Grid
-----
-
-.. automodule:: gerrychain.grid
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
-
-Metagraph
----------
-
-.. automodule:: gerrychain.metagraph
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
-
-Tree
-----
-
-.. automodule:: gerrychain.tree
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
-
 Constraints
 -----------
 
@@ -81,6 +54,7 @@ Constraints
     :show-inheritance:
     :noindex:
 
+
 Graph
 -----
 
@@ -102,6 +76,15 @@ Graph
     :show-inheritance:
     :noindex:
 
+Grid
+----
+
+.. automodule:: gerrychain.grid
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
 Meta
 ----
 
@@ -111,6 +94,15 @@ Meta
     :show-inheritance:
     :noindex:
 
+Metagraph
+---------
+
+.. automodule:: gerrychain.metagraph
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
 Metrics
 -------
 
@@ -126,6 +118,22 @@ Metrics
     :show-inheritance:
     :noindex:
 
+Optimization
+------------
+
+.. automodule:: gerrychain.optimization
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
+
+.. automodule:: gerrychain.gingleator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
 Partition
 ---------
 
@@ -174,6 +182,16 @@ Proposals
     :show-inheritance:
     :noindex:
 
+Tree
+----
+
+.. automodule:: gerrychain.tree
+    :members:
+    :undoc-members:
+    :show-inheritance:
+    :noindex:
+
+
 Updaters
 --------