diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2022-03-16 18:38:57 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-16 18:38:57 +0300 |
| commit | 4e9c1017edc3253f8cd95c9d5fef7bbac4b18211 (patch) | |
| tree | 25932533ea66f176f1390725c95b7bffb4028c78 /doc | |
| parent | b12b39db05d605cfb946f84afd27e0f6cf3c9e13 (diff) | |
| parent | b172dc1c90213956d8a55a0cbd98b74d292a69fe (diff) | |
Merge pull request #10260 from hugovk/colour-env-vars
Enable FORCE_COLOR and NO_COLOR for terminal colouring
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 |