You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can override these variables with the ``setenv`` option.
240
+
You can override these variables with the ``setenv`` option.
242
241
243
-
If defined the ``TOX_TESTENV_PASSENV`` environment variable (in the tox
244
-
invocation environment) can define additional space-separated variable
245
-
names that are to be passed down to the test command environment.
242
+
If defined the ``TOX_TESTENV_PASSENV`` environment variable (in the tox
243
+
invocation environment) can define additional space-separated variable
244
+
names that are to be passed down to the test command environment.
246
245
247
-
.. versionchanged:: 2.7
246
+
.. versionchanged:: 2.7
248
247
249
-
``PYTHONPATH`` will be passed down if explicitly defined. If ``PYTHONPATH``
250
-
exists in the host environment but is **not** declared in ``passenv`` a
251
-
warning will be emitted.
248
+
``PYTHONPATH`` will be passed down if explicitly defined. If
249
+
``PYTHONPATH`` exists in the host environment but is **not** declared
250
+
in ``passenv`` a warning will be emitted.
252
251
253
252
.. confval:: recreate=True|False(default)
254
253
255
254
Always recreate virtual environment if this option is True.
256
255
257
256
.. confval:: downloadcache=path
258
257
259
-
**IGNORED** -- Since pip-8 has caching by default this option is now ignored. Please remove it from your configs as a future tox version might bark on it.
258
+
**IGNORED** -- Since pip-8 has caching by default this option is now
259
+
ignored. Please remove it from your configs as a future tox version might
260
+
bark on it.
260
261
261
262
.. confval:: sitepackages=True|False
262
263
@@ -268,60 +269,65 @@ Complete list of settings that you can put into ``testenv*`` sections:
268
269
269
270
.. confval:: alwayscopy=True|False
270
271
271
-
Set to ``True`` if you want virtualenv to always copy files rather than symlinking.
272
+
Set to ``True`` if you want virtualenv to always copy files rather than
273
+
symlinking.
272
274
273
-
This is useful for situations where hardlinks don't work (e.g. running in VMS with Windows guests).
275
+
This is useful for situations where hardlinks don't work (e.g. running in
276
+
VMS with Windows guests).
274
277
275
278
**default:** False, meaning that virtualenvs will make use of symbolic links.
276
279
277
280
.. confval:: args_are_paths=BOOL
278
281
279
-
treat positional arguments passed to ``tox`` as file system paths
282
+
Treat positional arguments passed to ``tox`` as file system paths
280
283
and - if they exist on the filesystem - rewrite them according
281
284
to the ``changedir``.
285
+
282
286
**default**: True (due to the exists-on-filesystem check it's
283
287
usually safe to try rewriting).
284
288
285
289
.. confval:: envtmpdir=path
286
290
287
-
defines a temporary directory for the virtualenv which will be cleared
291
+
Defines a temporary directory for the virtualenv which will be cleared
288
292
each time before the group of test commands is invoked.
293
+
289
294
**default**: ``{envdir}/tmp``
290
295
291
296
.. confval:: envlogdir=path
292
297
293
-
defines a directory for logging where tox will put logs of tool
298
+
Defines a directory for logging where tox will put logs of tool
294
299
invocation.
300
+
295
301
**default**: ``{envdir}/log``
296
302
297
303
.. confval:: indexserver
298
304
299
-
.. versionadded:: 0.9
305
+
.. versionadded:: 0.9
300
306
301
-
(DEPRECATED, will be removed in a future version) Multi-line ``name =
302
-
URL`` definitions of python package servers. Dependencies can
303
-
specify using a specified index server through the
304
-
``:indexservername:depname`` pattern. The ``default`` indexserver
305
-
definition determines where unscoped dependencies and the sdist install
306
-
installs from. Example:
307
+
(DEPRECATED, will be removed in a future version) Multi-line ``name =
308
+
URL`` definitions of python package servers. Dependencies can
309
+
specify using a specified index server through the
310
+
``:indexservername:depname`` pattern. The ``default`` indexserver
311
+
definition determines where unscoped dependencies and the sdist install
312
+
installs from. Example:
307
313
308
-
.. code-block:: ini
314
+
.. code-block:: ini
309
315
310
316
[tox]
311
317
indexserver =
312
318
default = http://mypypi.org
313
319
314
-
will make tox install all dependencies from this PYPI index server
315
-
(including when installing the project sdist package).
316
-
320
+
will make tox install all dependencies from this PYPI index server
321
+
(including when installing the project sdist package).
317
322
318
323
.. confval:: envdir
319
324
320
-
.. versionadded:: 1.5
325
+
.. versionadded:: 1.5
326
+
327
+
User can set specific path for environment. If path would not be absolute
328
+
it would be treated as relative to ``{toxinidir}``.
321
329
322
-
User can set specific path for environment. If path would not be absolute it
323
-
would be treated as relative to ``{toxinidir}``. **default**:
324
-
``{toxworkdir}/{envname}``
330
+
**default**: ``{toxworkdir}/{envname}``
325
331
326
332
.. confval:: usedevelop=BOOL
327
333
@@ -363,7 +369,7 @@ Complete list of settings that you can put into ``testenv*`` sections:
363
369
364
370
.. confval:: description=SINGLE-LINE-TEXT
365
371
366
-
a short description of the environment, this will be used to explain
372
+
A short description of the environment, this will be used to explain
367
373
the environment to the user upon listing environments for the command
368
374
line with any level of verbosity higher than zero. **default**: empty string
0 commit comments