Skip to content

Commit cdf9456

Browse files
committed
Document NO_COLOR and FORCE_COLOR environment variables
1 parent 2a700cf commit cdf9456

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/man/sphinx-build.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,22 @@ variables to customize behavior:
304304
Additional options for :program:`sphinx-build`. These options can
305305
also be set via the shortcut variable **O** (capital 'o').
306306

307+
.. describe:: NO_COLOR
308+
309+
When set (regardless of value), :program:`sphinx-build` will not use color
310+
in terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``. See
311+
`no-color.org <https://no-color.org/>`__ for other libraries supporting this
312+
community standard.
313+
314+
.. versionadded:: 4.5.0
315+
316+
.. describe:: FORCE_COLOR
317+
318+
When set (regardless of value), :program:`sphinx-build` will use color in
319+
terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``.
320+
321+
.. versionadded:: 4.5.0
322+
307323
.. _when-deprecation-warnings-are-displayed:
308324

309325
Deprecation Warnings

0 commit comments

Comments
 (0)