Skip to content

Commit 81a6997

Browse files
committed
Updating docs on set_env 'file' option (INI vs TOML)
1 parent 222c89c commit 81a6997

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

docs/config.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -551,8 +551,26 @@ Base options
551551
.. conf::
552552
:keys: set_env, setenv
553553

554-
A dictionary of environment variables to set when running commands in the tox environment. Lines starting with a
555-
``file|`` prefix define the location of environment file.
554+
A dictionary of environment variables to set when running commands in the tox environment.
555+
556+
In addition, there is an option to include an existing environment file. See the different syntax for TOML and INI below.
557+
558+
.. tab:: TOML
559+
560+
.. code-block:: toml
561+
562+
[tool.tox.env_run_base]
563+
set_env = { file = "conf{/}local.env", TEST_TIMEOUT = 30 }
564+
565+
.. tab:: INI
566+
567+
568+
.. code-block:: ini
569+
570+
[testenv]
571+
set_env = file|conf{/}local.env
572+
TEST_TIMEOUT = 30
573+
556574
557575
.. note::
558576

0 commit comments

Comments
 (0)