Merge branch 'master' into catalog/758

Author: edwardchalstrey1

.github/workflows/python.yml

@@ -21,16 +21,15 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython wheel
-          pip install -r tests/requirements.txt
-          pip install -r doc/requirements.txt
+          python -m pip install build
       - name: Build source distribution
         run:
           python -m build
       - name: Build from source distribution
         run: |
           cd dist
-          pip install -v pygambit*.tar.gz
+          sdist=$(ls pygambit-*.tar.gz)
+          pip install -v "${sdist}[test,doc]"
       - name: Run tests
         run: pytest --run-tutorials
 
@@ -50,12 +49,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython wheel
-          pip install -r tests/requirements.txt
-          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
-          python -m pip install -v .
+          python -m pip install -v .[test,doc]
       - name: Run tests
         run: pytest --run-tutorials
 
@@ -75,12 +71,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython wheel
-          pip install -r tests/requirements.txt
-          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
-          python -m pip install -v .
+          python -m pip install -v .[test,doc]
       - name: Run tests
         run: pytest --run-tutorials
 
@@ -100,11 +93,8 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython wheel
-          pip install -r tests/requirements.txt
-          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
-          python -m pip install -v .
+          python -m pip install -v .[test,doc]
       - name: Run tests
         run: pytest --run-tutorials

.readthedocs.yml

@@ -20,6 +20,7 @@ build:
 
 python:
   install:
-    - requirements: doc/requirements.txt
     - method: pip
       path: "."
+      extra_requirements:
+        - doc

doc/developer.build.rst

@@ -188,7 +188,11 @@ Use `pip` to install from the **root directory of the source tree**:
 
    python -m venv venv
    source venv/bin/activate
-   python -m pip install .
+   python -m pip install .[test,doc]
+
+.. tip::
+
+   The "test" and "doc" optional dependencies are useful for developers wishing to run the test suite or build this documentation locally.
 
 
 Once installed, simply ``import pygambit`` in your Python shell or

doc/developer.contributing.rst

@@ -104,19 +104,16 @@ Be sure to familiarise yourself with :ref:`contributing-code` before reading thi
 By default, pull requests on GitHub will trigger the running of Gambit's test suite using GitHub Actions.
 You can also run the tests locally before submitting your pull request, using `pytest`.
 
-1. Install the test dependencies (into the virtual environment where you installed PyGambit): ::
+1. Ensure `pygambit` is installed with test dependencies: see :ref:`build-python`.
 
-    pip install -r tests/requirements.txt
+2. Run pytest: ::
 
-2. Navigate to the Gambit repository and run the tests: ::
-
-    pytest
-
-3. [Optional] If you wish to run the tutorial notebook tests, you will need to add the ``--run-tutorials`` flag, which require the `doc` dependencies: ::
-
-    pip install -r doc/requirements.txt
     pytest --run-tutorials
 
+.. tip::
+    You can omit the `--run-tutorials` to skip running the tutorial notebook tests which take longest to run.
+    Running tests including tutorials requires `doc` as well as `test` dependencies; see :ref:`build-python`.
+
 Adding to the test suite
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -136,9 +133,7 @@ You can also build the documentation locally to preview your changes before subm
 
 1. `Install Pandoc <https://pandoc.org/installing.html>`_ for your OS
 
-2. Install the docs dependencies (into the virtual environment where you installed PyGambit): ::
-
-    pip install -r doc/requirements.txt
+2. Ensure `pygambit` is installed with doc dependencies: see :ref:`build-python`.
 
 3. Navigate to the Gambit repo and build the docs: ::
 
@@ -158,7 +153,7 @@ To submit a tutorial for inclusion in the Gambit documentation, please follow th
 
 3. Update `doc/pygambit.rst` to ensure the tutorial is listed in the docs at an appropriate location.
 
-4. *[Optional]* If your tutorial requires additional dependencies not already listed in `doc/requirements.txt`, please add them to the file.
+4. *[Optional]* If your tutorial requires additional dependencies not already listed in the ``doc`` list under ``[project.optional-dependencies]`` inside ``pyproject.toml``, please add them to the file.
 
 
 Recognising contributions

doc/requirements.txt

@@ -8,29 +8,24 @@ The tutorials are available as Jupyter notebooks and can be run interactively us
 
 .. tip:: Create a virtual environment with Python 3.10 or higher.
 
-1. To download the tutorials, open your OS's command prompt and clone the Gambit repository from GitHub, then navigate to the tutorials directory: ::
+1. To download the tutorials, open your OS's command prompt and clone the Gambit repository from GitHub: ::
 
     git clone https://github.com/gambitproject/gambit.git
 
-2. Install `pygambit`:
+2. Install `pygambit` with additional documentation dependencies:
 
    * To install the latest release from PyPI::
 
-       pip install pygambit
+       pip install pygambit[doc]
 
-   * Alternatively, to install the latest development version::
+   * Alternatively, to install the latest development version (from the top level of the gambit repo)::
 
-       pip install .
-
-3. Install other requirements (including `JupyterLab`) used by the tutorials ::
-
-    cd gambit/doc
-    pip install -r requirements.txt
+       pip install .[doc]
 
    .. warning::
        Windows users wishing to run the "Using Gambit with OpenSpiel" tutorial will need to install OpenSpiel manually; see the `OpenSpiel installation instructions <https://openspiel.readthedocs.io/en/latest/windows.html>`_ for details.
 
-4. Open `JupyterLab` and click on any of the tutorial notebooks (files ending in `.ipynb`) ::
+3. Open `JupyterLab` and click on any of the tutorial notebooks in ``doc/tutorials`` (files ending in `.ipynb`) ::
 
-    cd tutorials
+    cd doc/tutorials
     jupyter lab

doc/tutorials/running_locally.rst

@@ -31,6 +31,21 @@ dependencies = [
     "pandas",
 ]
 
+[project.optional-dependencies]
+test = ["pytest", "nbformat", "nbclient", "ipykernel"]
+doc = [
+    "pydata-sphinx-theme",
+    "sphinx_design",
+    "sphinx-autobuild",
+    "nbsphinx",
+    "ipython",
+    "matplotlib",
+    "pickleshare",
+    "jupyter",
+    "open_spiel; sys_platform != 'win32'",
+    "draw-tree @ git+https://github.com/gambitproject/draw_tree.git@v0.3.1"
+]
+
 [project.urls]
 Homepage = "https://www.gambit-project.org"
 Documentation = "https://gambitproject.readthedocs.io"