Skip to content

Docs fix: move depends and parallel_show_output into the right section #1366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2019
Merged

Docs fix: move depends and parallel_show_output into the right section #1366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/config.rst
View file
Open in desktop
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