docs: color output for docs

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.readthedocs.yml

@@ -3,11 +3,9 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.12"
+  os: ubuntu-24.04
   commands:
     - asdf plugin add uv
     - asdf install uv latest
     - asdf global uv latest
-    - NO_COLOR=1 uv run --no-dev --group docs mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html
+    - NO_COLOR=1 uv run -p 3.14 --no-dev --group docs mkdocs build --strict --site-dir $READTHEDOCS_OUTPUT/html

docs/main.py

@@ -1,8 +1,12 @@
 import os
+import re
 import subprocess
 import sysconfig
 from typing import Any
 
+import rich.console
+import rich.text
+
 
 def define_env(env: Any) -> None:
     "Hook function for mkdocs-macros"
@@ -12,5 +16,13 @@ def subprocess_run(*args: str) -> str:
         "Run a subprocess and return the stdout"
         env = os.environ.copy()
         scripts = sysconfig.get_path("scripts")
+        env.pop("NO_COLOR", None)
         env["PATH"] = f"{scripts}{os.pathsep}{env.get('PATH', '')}"
-        return subprocess.run(args, check=True, capture_output=True, text=True, env=env).stdout
+        env["PYTHON_COLORS"] = "1"
+        output = subprocess.run(args, check=True, capture_output=True, text=True, env=env).stdout
+        rich_text = rich.text.Text.from_ansi(output)
+        console = rich.console.Console(record=True)
+        console.print(rich_text)
+        page = console.export_html(inline_styles=True)
+        text = re.search(r"<body.*?>(.*?)</body>", page, re.DOTALL | re.IGNORECASE).group(1)
+        return text.strip()

docs/options.md

@@ -1714,9 +1714,7 @@ Platform-specific environment variables are also available:<br/>
 
 ### Options
 
-```text
 « subprocess_run("cibuildwheel", "--help") »
-```
 
 ### Return codes
 

pyproject.toml

@@ -76,6 +76,7 @@ docs = [
     "mkdocs-macros-plugin",
     "mkdocs==1.6.1",
     "pymdown-extensions",
+    "rich",
 ]
 test = [
     "build",