IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10260 from hugovk/colour-env-vars

Browse Source 
Enable FORCE_COLOR and NO_COLOR for terminal colouring
This commit is contained in:
Takeshi KOMIYA
2022-03-17 00:38:57 +09:00
committed by GitHub
parent b12b39db05 b172dc1c90
commit 4e9c1017ed
4 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/man/sphinx-build.rst
View File

@@ -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