Skip to content

Commit

Permalink
improve poetry usage documentation (rytilahti#830)
Browse files Browse the repository at this point in the history
* improve poetry usage documentation

* cleanup
  • Loading branch information
rytilahti authored and xvlady committed May 9, 2021
1 parent 3874a2a commit 6011a91
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/new_devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ Development environment
-----------------------

This section will shortly go through how to get you started with a working development environment.
We use `poetry <https://python-poetry.org/>`__ for managing the dependencies and packaging, so simply execute:
We use `poetry <https://python-poetry.org/>`__ for managing the dependencies and packaging, so simply execute::

poetry install

To verify the installation, simply launch tox_ to run all the checks::
If you were not already inside a virtual environment during the install,
poetry will create one for you.
You can execute commands inside this environment by using ``poetry run <command>``,
or alternatively,
enter the virtual environment shell by executing ``poetry shell`` to avoid repeating ``poetry run``.

To verify the installation, you can launch tox_ to run all the checks::

tox

Expand Down

0 comments on commit 6011a91

Please sign in to comment.