diff options
| author | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2022-03-13 18:43:22 +0300 |
|---|---|---|
| committer | Hugo van Kemenade <hugovk@users.noreply.github.com> | 2022-03-13 18:43:22 +0300 |
| commit | cdf9456699fabae836a94ed22956d00b12f47a21 (patch) | |
| tree | 04202a5f95ac6f4863ee83fd2604f4d52b755c41 /doc | |
| parent | 2a700cf8e551ac44aebe938640b673f99af1cf9f (diff) | |
Document NO_COLOR and FORCE_COLOR environment variables
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/sphinx-build.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/man/sphinx-build.rst b/doc/man/sphinx-build.rst index ca16b265a..9bba4a55a 100644 --- a/doc/man/sphinx-build.rst +++ b/doc/man/sphinx-build.rst @@ -304,6 +304,22 @@ variables to customize behavior: Additional options for :program:`sphinx-build`. These options can also be set via the shortcut variable **O** (capital 'o'). +.. describe:: NO_COLOR + + When set (regardless of value), :program:`sphinx-build` will not use color + in terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``. See + `no-color.org <https://no-color.org/>`__ for other libraries supporting this + community standard. + + .. versionadded:: 4.5.0 + +.. describe:: FORCE_COLOR + + When set (regardless of value), :program:`sphinx-build` will use color in + terminal output. ``NO_COLOR`` takes precedence over ``FORCE_COLOR``. + + .. versionadded:: 4.5.0 + .. _when-deprecation-warnings-are-displayed: Deprecation Warnings |