Skip to content

Commit b76781b

Browse files
authored
Docs link of env var subs section to set_env (#3039)
* Hyperlinked env var substitutions docs in set_env * Added link to pass_env and tweaked wording a bit * Added changelog entry * Using :ref: to preserve title name (avoid redefining name)
1 parent 1fed050 commit b76781b

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/changelog/3039.doc.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Linked environment variable substitutions docs in
2+
``set_env`` and ``pass_env`` config docs.

docs/config.rst

+8
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,9 @@ Base options
285285
tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example:
286286
passing ``A`` or ``a`` will pass through both ``A`` and ``a``.
287287

288+
More environment variable-related information
289+
can be found in :ref:`environment variable substitutions`.
290+
288291
.. conf::
289292
:keys: set_env, setenv
290293

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

306+
More environment variable-related information
307+
can be found in :ref:`environment variable substitutions`.
308+
303309
.. conf::
304310
:keys: parallel_show_output
305311
:default: False
@@ -830,6 +836,8 @@ Special substitutions that accept additional colon-delimited ``:`` parameters
830836
cannot have a space after the ``:`` at the beginning of line (e.g. ``{posargs:
831837
magic}`` would be parsed as factorial ``{posargs``, having value magic).
832838

839+
.. _`environment variable substitutions`:
840+
833841
Environment variable substitutions
834842
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
835843

0 commit comments

Comments
 (0)