From 7157befd34f6255095ba40ae02ef65601b0b8fba Mon Sep 17 00:00:00 2001 From: mhostetter Date: Sat, 4 Nov 2023 11:37:13 -0400 Subject: [PATCH] Update documentation of dev dependencies --- docs/development/installation.rst | 15 ++++++--------- docs/development/unit-tests.rst | 2 +- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/development/installation.rst b/docs/development/installation.rst index 9ad003006..19f038db2 100644 --- a/docs/development/installation.rst +++ b/docs/development/installation.rst @@ -46,17 +46,14 @@ Install the local folder using the `-e` or `--editable` flag. Install the `dev` dependencies ------------------------------ -The development dependencies include packages for linting and unit testing. These dependencies are stored -in `pyproject.toml`. +The development dependencies include packages for linting and unit testing. +These dependencies are stored in `requirements-dev.txt`. -.. literalinclude:: ../../pyproject.toml - :caption: pyproject.toml - :start-at: [project.optional-dependencies] - :end-before: [project.urls] - :language: toml +.. literalinclude:: ../../requirements-dev.txt + :caption: requirements-dev.txt -Install the development dependencies by passing the `[dev]` extras to `pip install`. +Install the development dependencies by passing `-r` to `pip install`. .. code-block:: console - $ python3 -m pip install galois[dev] + $ python3 -m pip install -r requirements-dev.txt diff --git a/docs/development/unit-tests.rst b/docs/development/unit-tests.rst index 9b601f932..7ab301772 100644 --- a/docs/development/unit-tests.rst +++ b/docs/development/unit-tests.rst @@ -10,7 +10,7 @@ First, `pytest` needs to be installed on your system. Easily install it by insta .. code-block:: console - $ python3 -m pip install .[dev] + $ python3 -m pip install -r requirements-dev.txt Configuration -------------