diff options
| author | Juergen Borleis <jbe@pengutronix.de> | 2017-11-14 13:03:02 +0100 |
|---|---|---|
| committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2017-11-17 17:15:38 +0100 |
| commit | f3e8c77057f266b0b673cebf540bbf6aa4f8c05d (patch) | |
| tree | 15e01852cab74adf5c53e34e77ed0644ef113ee4 /doc | |
| parent | efebcad7d3bd4d3d1e4cbdc280ce5bf29f298cdf (diff) | |
| download | ptxdist-f3e8c77057f266b0b673cebf540bbf6aa4f8c05d.tar.gz ptxdist-f3e8c77057f266b0b673cebf540bbf6aa4f8c05d.tar.xz | |
PTXdist: add virtual environment awareness
Required to work with local python tools.
Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/including_bsp_doc.inc | 3 | ||||
| -rw-r--r-- | doc/ref_parameter.inc | 3 |
2 files changed, 5 insertions, 1 deletions
diff --git a/doc/including_bsp_doc.inc b/doc/including_bsp_doc.inc index f1f65ff48..eef89ca41 100644 --- a/doc/including_bsp_doc.inc +++ b/doc/including_bsp_doc.inc @@ -37,7 +37,8 @@ when not globally present in the host system. $ pip3 install sphinx_rtd_theme .. note:: Whenever you want to create the PTXdist user manual, you must first - source the ``env/bin/activate`` file if not already done. + source the ``env/bin/activate`` file if not already done or do each PTXdist + call with the --virtualenv=<dir> parameter. Building the Documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/ref_parameter.inc b/doc/ref_parameter.inc index d87c731c1..56f6e6a40 100644 --- a/doc/ref_parameter.inc +++ b/doc/ref_parameter.inc @@ -313,3 +313,6 @@ Options the correct PTXdist version in the ptxconfig file and execute it if it does not match the current version. +``--virtualenv=<dir>`` + inlcude a Python Virtual Environment. The given path must contain a + ``bin/activate`` shell script. |