From bfb049cd6942adbce1a4471fdd1beedf71124449 Mon Sep 17 00:00:00 2001 From: Ed Chalstrey Date: Fri, 13 Mar 2026 11:33:27 +0000 Subject: [PATCH] Add key step to catalog update instructions --- doc/developer.catalog.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/developer.catalog.rst b/doc/developer.catalog.rst index b60a56705..349d1792c 100644 --- a/doc/developer.catalog.rst +++ b/doc/developer.catalog.rst @@ -4,6 +4,7 @@ Updating the Games Catalog This page covers the process for contributing to and updating Gambit's :ref:`Games Catalog `. To do so, you will need to have the `gambit` GitHub repo cloned and be able to submit pull request via GitHub; you may wish to first review the :ref:`contributor guidelines `. +You'll also need to have a developer install of `pygambit` available in your Python environment, see :ref:`build-python`. You can add games to the catalog saved in a valid representation :ref:`format `. Currently supported representations are: @@ -24,16 +25,14 @@ Add new games 3. **Update the catalog:** - Use the ``update.py`` script to update Gambit's documentation & build files. + Reinstall the package to pick up the new game file(s) in the ``pygambit.catalog`` module. + Then use the ``update.py`` script to update Gambit's documentation & build files. .. code-block:: bash + pip install . python build_support/catalog/update.py --build - .. note:: - - Run this script in a Python environment where ``pygambit`` itself is also :ref:`installed `. - .. warning:: Running the script with the ``--build`` flag updates `Makefile.am`. If you moved games that were previously in `contrib/games` you'll need to also manually remove those files from `EXTRA_DIST`.