From 2efa5bce54a2d09573e62a580047b5c7419bbedc Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Mon, 20 Jan 2025 23:35:16 +0000
Subject: [PATCH] Install matplotlib for opengraph preview images (#242)

---
 build_docs.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/build_docs.py b/build_docs.py
index 40384b8..a6b08bb 100755
--- a/build_docs.py
+++ b/build_docs.py
@@ -745,6 +745,10 @@ def build(self):
         blurb = self.venv / "bin" / "blurb"
 
         if self.includes_html:
+            # Define a tag to enable opengraph socialcards previews
+            # (used in Doc/conf.py and requires matplotlib)
+            sphinxopts.append("-t create-social-cards")
+
             # Disable CPython switchers, we handle them now:
             run(
                 ["sed", "-i"]
@@ -783,13 +787,17 @@ def build_venv(self):
         So we can reuse them from builds to builds, while they contain
         different Sphinx versions.
         """
+        requirements = [self.theme] + self.version.requirements
+        if self.includes_html:
+            # opengraph previews
+            requirements.append("matplotlib>=3")
+
         venv_path = self.build_root / ("venv-" + self.version.name)
         run([sys.executable, "-m", "venv", venv_path])
         run(
             [venv_path / "bin" / "python", "-m", "pip", "install", "--upgrade"]
             + ["--upgrade-strategy=eager"]
-            + [self.theme]
-            + self.version.requirements,
+            + requirements,
             cwd=self.checkout / "Doc",
         )
         run([venv_path / "bin" / "python", "-m", "pip", "freeze", "--all"])