From 9c7afd61783c670027eb1fbc3e15b62520358841 Mon Sep 17 00:00:00 2001 From: peterrrock2 Date: Fri, 24 May 2024 12:39:39 -0600 Subject: [PATCH] Update full package reference to include optimizers --- docs/full_ref.rst | 72 +++++++++++++++++++++++++++++------------------ 1 file changed, 45 insertions(+), 27 deletions(-) diff --git a/docs/full_ref.rst b/docs/full_ref.rst index 5b22a636..71b39684 100644 --- 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 --------