Skip to content

Commit

Permalink
Move depends and parallel_show_output into the right section (tox-dev…
Browse files Browse the repository at this point in the history
…#1366)

`depends` and `parallel_show_output` are not global settings, they're per-environment settings.  I think they got listed in the global settings section by accident.
  • Loading branch information
mgedmin authored and asottile committed Jul 8, 2019
1 parent a0487da commit e4c7752
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,25 +160,6 @@ Global settings are defined under the ``tox`` section as:
Name of the virtual environment used to create a source distribution from the
source tree.

.. conf:: parallel_show_output ^ bool ^ false

.. versionadded:: 3.7.0

If set to True the content of the output will always be shown when running in parallel mode.

.. conf:: depends ^ comma separated values

.. versionadded:: 3.7.0

tox environments this depends on. tox will try to run all dependent environments before running this
environment. Format is same as :conf:`envlist` (allows factor usage).

.. warning::

``depends`` does not pull in dependencies into the run target, for example if you select ``py27,py36,coverage``
via the ``-e`` tox will only run those three (even if ``coverage`` may specify as ``depends`` other targets too -
such as ``py27, py35, py36, py37``).


Jenkins override
++++++++++++++++
Expand Down Expand Up @@ -543,6 +524,25 @@ Complete list of settings that you can put into ``testenv*`` sections:
the environment to the user upon listing environments for the command
line with any level of verbosity higher than zero.

.. conf:: parallel_show_output ^ bool ^ false

.. versionadded:: 3.7.0

If set to True the content of the output will always be shown when running in parallel mode.

.. conf:: depends ^ comma separated values

.. versionadded:: 3.7.0

tox environments this depends on. tox will try to run all dependent environments before running this
environment. Format is same as :conf:`envlist` (allows factor usage).

.. warning::

``depends`` does not pull in dependencies into the run target, for example if you select ``py27,py36,coverage``
via the ``-e`` tox will only run those three (even if ``coverage`` may specify as ``depends`` other targets too -
such as ``py27, py35, py36, py37``).

Substitutions
-------------

Expand Down

0 comments on commit e4c7752

Please sign in to comment.