Skip to content
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

Docs link of env var subs section to set_env #3039

Merged
merged 4 commits into from
Jun 17, 2023
Merged

Docs link of env var subs section to set_env #3039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cfb7f05
Hyperlinked env var substitutions docs in set_env
jamesbraza Jun 17, 2023
b8d57ad
Added link to pass_env and tweaked wording a bit
jamesbraza Jun 17, 2023
b0e0788
Added changelog entry
jamesbraza Jun 17, 2023
bf06a7e
Using :ref: to preserve title name (avoid redefining name)
jamesbraza Jun 17, 2023
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
2 changes: 2 additions & 0 deletions docs/changelog/3039.doc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Linked environment variable substitutions docs in
``set_env`` and ``pass_env`` config docs.
8 changes: 8 additions & 0 deletions docs/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,9 @@ Base options
tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example:
passing ``A`` or ``a`` will pass through both ``A`` and ``a``.

More environment variable-related information
can be found in :ref:`environment variable substitutions`.

.. conf::
:keys: set_env, setenv

Expand All @@ -300,6 +303,9 @@ Base options
- each line is in KEY=VALUE format; both the key and the value are stripped,
- there is no special handling of quotation marks, they are part of the key or value.

More environment variable-related information
can be found in :ref:`environment variable substitutions`.

.. conf::
:keys: parallel_show_output
:default: False
Expand Down Expand Up @@ -830,6 +836,8 @@ Special substitutions that accept additional colon-delimited ``:`` parameters
cannot have a space after the ``:`` at the beginning of line (e.g. ``{posargs:
magic}`` would be parsed as factorial ``{posargs``, having value magic).

.. _`environment variable substitutions`:

Environment variable substitutions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down