You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/developer.catalog.rst
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ Updating the Games Catalog
4
4
This page covers the process for contributing to and updating Gambit's :ref:`Games Catalog <pygambit-catalog>`.
5
5
To do so, you will need to have the `gambit` GitHub repo cloned and be able to submit pull request via GitHub;
6
6
you may wish to first review the :ref:`contributor guidelines <contributing>`.
7
+
You'll also need to have a developer install of `pygambit` available in your Python environment, see :ref:`build-python`.
7
8
8
9
You can add games to the catalog saved in a valid representation :ref:`format <file-formats>`.
9
10
Currently supported representations are:
@@ -24,16 +25,14 @@ Add new games
24
25
25
26
3. **Update the catalog:**
26
27
27
-
Use the ``update.py`` script to update Gambit's documentation & build files.
28
+
Reinstall the package to pick up the new game file(s) in the ``pygambit.catalog`` module.
29
+
Then use the ``update.py`` script to update Gambit's documentation & build files.
28
30
29
31
.. code-block:: bash
30
32
33
+
pip install .
31
34
python build_support/catalog/update.py --build
32
35
33
-
.. note::
34
-
35
-
Run this script in a Python environment where ``pygambit`` itself is also :ref:`installed <build-python>`.
36
-
37
36
.. warning::
38
37
39
38
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`.
0 commit comments