use update script to update api reference doc

Author: edwardchalstrey1

doc/pygambit.api.rst

@@ -336,3 +336,148 @@ Game catalog
    :toctree: api/
 
    games
+   Artist1
+   Artist2
+   Badgame1
+   Badgame2
+   Bagwell
+   Bayes1a
+   Bayes2a
+   Bcp2
+   Bcp3
+   Bcp4
+   Bhg1
+   Bhg2
+   Bhg3
+   Bhg4
+   Bhg5
+   Caro2
+   Cent2
+   Cent2NFG
+   Cent3
+   Cent4
+   Cent6
+   Centcs10
+   Centcs6
+   Condjury
+   Coord2
+   Coord2NFG
+   Coord2ts
+   Coord3
+   Coord333
+   Coord3NFG
+   Coord4
+   Coord4NFG
+   Cross
+   Cs
+   Csg1
+   Csg2
+   Csg3
+   Csg4
+   Deg1
+   Deg2
+   E01
+   E01NFG
+   E02
+   E02NFG
+   E03
+   E04
+   E04NFG
+   E05
+   E06
+   E07
+   E07NFG
+   E08
+   E09
+   E10
+   E10a
+   E13
+   E16
+   E17
+   E18
+   G1
+   G1NFG
+   G2
+   G2NFG
+   G3
+   G3NFG
+   Game2s2x2x2
+   Game2smp
+   Game2x2
+   Game2x2a
+   Game2x2const
+   Game2x2x2
+   Game2x2x2NFG
+   Game2x2x2_nau
+   Game2x2x2x2
+   Game2x2x2x2x2
+   Game3x3x3
+   Game4cards
+   Game5x4x3
+   Game8x2x2
+   Game8x8
+   Holdout
+   Holdout7
+   Hs1
+   Jury_mr
+   Jury_un
+   Km1
+   Km2
+   Km3
+   Km6
+   Loopback
+   Mixdom
+   Mixdom2
+   Montyhal
+   My_2_1
+   My_2_4
+   My_2_8
+   My_3_3a
+   My_3_3b
+   My_3_3c
+   My_3_3d
+   My_3_3e
+   My_3_4
+   Myerson
+   Myerson_fig_4_2
+   Nim
+   Nim7
+   Oneill
+   Palf
+   Palf2
+   Palf3
+   Pbride
+   Perfect1
+   Perfect2
+   Perfect3
+   Poker
+   Poker2
+   PokerNFG
+   PrisonersDilemma
+   Pvw
+   Pvw2
+   Sh3
+   Sh3NFG
+   Spence
+   Stengel
+   Sww1
+   Sww1NFG
+   Sww2
+   Sww3
+   Tim
+   Todd1
+   Todd2
+   Todd3
+   Ttt
+   Vd
+   VdNFG
+   W_ex1
+   W_ex2
+   Wilson1
+   Wink3
+   Winkels
+   Work1
+   Work2
+   Work3
+   Yamamoto
+   Zero

src/pygambit/catalog/update.py

@@ -6,6 +6,7 @@
 
 _CATALOG_YAML = Path(__file__).parent / "catalog.yml"
 _GAMEFILES_DIR = Path(__file__).parent.parent.parent.parent / "contrib/games"
+_API_RST = Path(__file__).parent.parent.parent.parent / "doc/pygambit.api.rst"
 
 
 def make_class_name(filename: str) -> str:
@@ -26,6 +27,48 @@ def make_class_name(filename: str) -> str:
     return name
 
 
+def update_api_rst(catalog: dict[str, dict]) -> None:
+    """Update the Game catalog section in pygambit.api.rst with all class names."""
+    with open(_API_RST, encoding="utf-8") as f:
+        content = f.read()
+
+    # Find the Game catalog section
+    game_catalog_start = content.find("Game catalog\n~~~~~~~~~~~~")
+    if game_catalog_start == -1:
+        print("Warning: 'Game catalog' section not found in pygambit.api.rst")
+        return
+
+    # Find the autosummary block
+    autosummary_start = content.find(".. autosummary::", game_catalog_start)
+    toctree_start = content.find(":toctree: api/", autosummary_start)
+
+    # Find the next section (starts with ~~)
+    next_section = content.find("\n~~", toctree_start)
+    if next_section == -1:
+        next_section = len(content)
+
+    # Build the new toctree content
+    class_names = sorted(catalog.keys())
+    new_toctree = ".. autosummary::\n   :toctree: api/\n\n   games\n"
+    for class_name in class_names:
+        new_toctree += f"   {class_name}\n"
+
+    # Replace the old toctree with the new one
+    old_toctree_start = content.rfind(".. autosummary::", game_catalog_start, toctree_start + 100)
+    old_toctree_end = next_section
+
+    new_content = (
+        content[:old_toctree_start]
+        + new_toctree
+        + content[old_toctree_end:]
+    )
+
+    with open(_API_RST, "w", encoding="utf-8") as f:
+        f.write(new_content)
+
+    print(f"Updated {_API_RST} with {len(class_names)} catalog games")
+
+
 if __name__ == "__main__":
     # Use ruamel.yaml to preserve comments
     yaml = YAML()
@@ -69,6 +112,9 @@ def make_class_name(filename: str) -> str:
     with _CATALOG_YAML.open("w", encoding="utf-8") as f:
         yaml.dump(catalog, f)
 
+    # Update the RST documentation
+    update_api_rst(catalog)
+
     print(f"Added {new_entries_counter} new entries to the catalog")
     print(f"Output written to: {_CATALOG_YAML}")
     print("Done.")