Skip to content

Commit

Permalink
Update documentation of dev dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Nov 4, 2023
1 parent e1a4941 commit 7157bef
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
15 changes: 6 additions & 9 deletions docs/development/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/development/unit-tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down

0 comments on commit 7157bef

Please sign in to comment.