Merge pull request #104524 from wheatear-dev/disable-colors-doc-option

Support a `NO_COLOR` environment variable in `doc_status.py`

Author: Repiteo

doc/tools/doc_status.py

@@ -10,7 +10,7 @@
 
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../"))
 
-from misc.utility.color import STDOUT_COLOR, Ansi, toggle_color
+from misc.utility.color import NO_COLOR, STDOUT_COLOR, Ansi, toggle_color
 
 ################################################################################
 #                                    Config                                    #
@@ -114,6 +114,8 @@ def validate_tag(elem: ET.Element, tag: str) -> None:
 
 
 def color(color: str, string: str) -> str:
+    if NO_COLOR:
+        return string
     color_format = "".join([str(x) for x in colors[color]])
     return f"{color_format}{string}{Ansi.RESET}"
 

misc/utility/color.py

@@ -9,6 +9,7 @@
 # to a file, it won't contain color codes. Colors are always enabled on continuous integration.
 
 IS_CI: Final[bool] = bool(os.environ.get("CI"))
+NO_COLOR: Final[bool] = bool(os.environ.get("NO_COLOR"))
 STDOUT_TTY: Final[bool] = bool(sys.stdout.isatty())
 STDERR_TTY: Final[bool] = bool(sys.stderr.isatty())