Add code for adding images for catalog games in the future

Author: edwardchalstrey1

src/pygambit/catalog.py

@@ -38,19 +38,19 @@ def _game() -> gbt.Game:
         """
         raise NotImplementedError("Subclasses must implement _game() method")
 
-    @classmethod
-    def _img_docstring(cls) -> str:
-        """Return the image docstring for the game."""
-        # file = f"/_static/catalog_drawn/{cls.__name__}.png"
-        file = "/_static/gambit.png"
-        docstring = f"""
-            .. figure:: {file}
-                :align: center
-                :width: 400px
-
-                {cls.__name__} game diagram
-        """
-        return docstring
+    # TODO: Add images for catalog games
+    # @classmethod
+    # def _img_docstring(cls) -> str:
+    #     """Return the image docstring for the game."""
+    #     file = f"/_static/catalog_drawn/{cls.__name__}.png"
+    #     docstring = f"""
+    #         .. figure:: {file}
+    #             :align: center
+    #             :width: 400px
+
+    #             {cls.__name__} game diagram
+    #     """
+    #     return docstring
 
     @classmethod
     def _extract_description(cls, game: gbt.Game) -> None:
@@ -63,7 +63,10 @@ def _extract_description(cls, game: gbt.Game) -> None:
             cleaned_docstring = game.description
         if len(cleaned_docstring) > 0:
             cleaned_docstring += "\n"
-        cleaned_docstring += cls._img_docstring()
+
+        # TODO: Add images for catalog games
+        # cleaned_docstring += cls._img_docstring()
+
         # If the class has a _game function, concatenate its docstring to the class docstring
         game_docstring = inspect.getdoc(cls._game)
         if game_docstring:

src/pygambit/catalog_update.py

@@ -125,6 +125,23 @@ def update_makefile():
         print(f"Updated {_MAKEFILE_AM}")
 
 
+# TODO: Add images for catalog games
+# def generate_draw_tree_images():
+#     """Generate tree images for all extensive-form games in the catalog."""
+#     from draw_tree import generate_png
+#     for class_name in gbt.catalog.games():
+#         cls = getattr(gbt.catalog, class_name)
+#         g = cls()
+#         if g.is_tree:
+#             image_path = (
+#                 Path(__file__).parent.parent.parent
+#                 / "doc/_static/catalog_drawn/"
+#                 / f"{class_name}.png"
+#             )
+#             generate_png(g, output_png=image_path)
+#             print(f"Generated tree image for {class_name} at {image_path}")
+
+
 if __name__ == "__main__":
     # Use ruamel.yaml to preserve comments
     yaml = YAML()
@@ -179,4 +196,8 @@ def update_makefile():
     # Update the Makefile.am with all game files
     update_makefile()
 
+    # TODO: Add images for catalog games
+    # Generate EFG game images and add to _static/catalog_drawn/
+    # generate_draw_tree_images()
+
     print("Done.")