diff options
| author | Lukasz Balcerzak <lukaszbalcerzak@gmail.com> | 2013-06-20 20:31:16 +0200 |
|---|---|---|
| committer | Lukasz Balcerzak <lukaszbalcerzak@gmail.com> | 2013-06-20 20:31:16 +0200 |
| commit | f3b35574de59f5fb2e814a463318f5af5de1f11e (patch) | |
| tree | 22553f8fab8a6fb68a880302d814f07c694f9cb5 | |
| parent | 64622fe8158e4072650e73feae6e7dbd81d3370e (diff) | |
| download | tox-f3b35574de59f5fb2e814a463318f5af5de1f11e.tar.gz | |
Updated documentation for development environment
| -rw-r--r-- | doc/config.txt | 8 | ||||
| -rw-r--r-- | doc/example/devenv.txt | 10 |
2 files changed, 13 insertions, 5 deletions
diff --git a/doc/config.txt b/doc/config.txt index b4a3c58..0fbd314 100644 --- a/doc/config.txt +++ b/doc/config.txt @@ -163,6 +163,14 @@ Complete list of settings that you can put into ``testenv*`` sections: (including when installing the project sdist package). +.. confval:: envdir + + .. versionadded:: 1.5 + + User can set specific path for environment. If path would not be absolute it + would be treated as relative to ``{toxinidir}``. **default**: + ``{toxworkdir}/{envname}`` + Substitutions --------------------- diff --git a/doc/example/devenv.txt b/doc/example/devenv.txt index 02e307c..90b294d 100644 --- a/doc/example/devenv.txt +++ b/doc/example/devenv.txt @@ -20,7 +20,7 @@ order to do that, we must define proper section at ``tox.ini`` file and tell at what directory environment should be created. Moreover, we need to specify python version that should be picked:: - [devenv] + [testenv:devenv] envdir = devenv basepython = python2.7 @@ -38,10 +38,10 @@ Creating development environment Once ``devenv`` section is defined we can instrument tox to create our environment:: - tox --devenv + tox -e devenv --envonly -This will create an environment at path specified by ``envdir`` under ``devenv`` -section. +This will create an environment at path specified by ``envdir`` under +``[testenv:devenv]`` section. @@ -54,7 +54,7 @@ Python 2.7. Here is example configuration for that:: - [devenv] + [testenv:devenv] envdir = devenv changedir = devenv basepython = python2.7 |
