Skip to content

Commit 4427cf3

Browse files
committed
Documentation for #3995
Signed-off-by: Stavros Ntentos <[email protected]>
1 parent 7f38e76 commit 4427cf3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/user_guide/usage/output.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ a colorized report to stdout at the same time:
2121

2222
--output-format=json:somefile.json,colorized
2323

24+
Environment Variables
25+
''''''''''''''''''''''''''''
26+
The colorization of the output can also be controlled through environment
27+
variables. The precedence for determining output format is as follows:
28+
29+
1. ``NO_COLOR``
30+
2. ``FORCE_COLOR``, or ``PY_COLORS``
31+
3. ``--output-format=...``
32+
33+
Setting ``NO_COLOR`` (to any value) will disable colorized output, while
34+
``FORCE_COLOR`` or ``PY_COLORS`` (to any value) will enable it, overriding
35+
the ``--output-format`` option if specified.
36+
2437

2538
Custom message formats
2639
''''''''''''''''''''''

0 commit comments

Comments
 (0)