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.

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

Fix broken path instructions in setting up a dev environment #4519

Merged
merged 4 commits into from
Sep 29, 2021
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/dev/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,22 @@ See the previous section for instructions.
pytest .
```

4. (**OPTIONAL**) include your development copy of cirq in your python path.
4. (**OPTIONAL**) include your development copy of cirq and its subpackages in your python path.

```bash
PYTHONPATH="$(pwd)":"${PYTHONPATH}"
./dev_tools/pypath
```

or add it to the python path, but only in the virtualenv.
or add it to the python path, but only in the virtualenv by first listing the modules

```bash
add2virtualenv ./
python dev_tools/modules.py list
```
and then adding these to the virtualenv:
```bash
add2virtualenv <paste modules from last command>
```
(Typically `add2virtualenv` is not executable using xargs, so this two step process is necessary.)

## Editable installs

Expand Down