diff options
| author | Chandan Singh <chandan@chandansingh.net> | 2020-05-04 22:55:47 +0000 |
|---|---|---|
| committer | Chandan Singh <chandan@chandansingh.net> | 2020-05-04 23:00:14 +0000 |
| commit | 7589dca9f6155ff8ba1dfacfbf8b5c5912c1fd68 (patch) | |
| tree | 7ad2e96dfb41b73d1d829912195351479181f575 | |
| parent | a79eadb07e5e55e979ffb27942488b4dce777e1e (diff) | |
| download | buildstream-chandan/venv-install-link.tar.gz | |
doc/format_project: Add links related to virtual environmentschandan/venv-install-link
Add links to Python's official virtual environment tutorial and our
BuildStream virtual environment instructions.
| -rw-r--r-- | doc/source/format_project.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index aa2168d3f..8cdced8f0 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -522,9 +522,13 @@ Here are a couple of examples: of plugins to use. In order to guarantee that you can use a specific version of a plugin, - you may need to install BuildStream into a *virtual environment* in order - to control which python package versions are available when using your - project. + you may need to install BuildStream into a `virtual environment + <https://docs.python.org/3/tutorial/venv.html>`_ in order to control which + python package versions are available when using your project. + + Follow `these instructions + <https://buildstream.build/source_install.html#installing-in-virtual-environments>`_ + to install BuildStream in a virtual environment. **Possible junction conflicts** |