Skip to content
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

improve poetry usage documentation #830

Merged
merged 2 commits into from
Oct 7, 2020
Merged

improve poetry usage documentation #830

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a53cc7e
improve poetry usage documentation
rytilahti Oct 6, 2020
72a6bc9
cleanup
rytilahti Oct 6, 2020
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
10 changes: 8 additions & 2 deletions docs/new_devices.rst
View file
Open in desktop
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