Skip to content

Commit

Permalink
Fix broken path instructions in setting up a dev environment (#4519)
Browse files Browse the repository at this point in the history
For the add2virtualenv I could only figure out a way to do it in two steps (this was on mac running big sur).  If anyone has some shell foo to make this one line, that would be great.
  • Loading branch information
dabacon committed Sep 29, 2021
1 parent 004eed1 commit 88be1ef
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/dev/development.md
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

0 comments on commit 88be1ef

Please sign in to comment.