Skip to content

Add key step to catalog update instructions #800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
edwardchalstrey1 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add key step to catalog update instructions #800

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions doc/developer.catalog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Updating the Games Catalog
This page covers the process for contributing to and updating Gambit's :ref:`Games Catalog <pygambit-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 <contributing>`.
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 <file-formats>`.
Currently supported representations are:
Expand All @@ -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 <build-python>`.

.. 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`.
Expand Down
Loading