From 908fec687a8542ff6ea0e9b7423e13cee14e1a57 Mon Sep 17 00:00:00 2001
From: Feanil Patel <feanil@axim.org>
Date: Wed, 25 Sep 2024 12:48:49 -0400
Subject: [PATCH] build: Manually pull some RTD Context.

See https://about.readthedocs.com/blog/2024/07/addons-by-default/ for details but
essentially RTD is changing how it's building docs and this will let us handle the
change gracefully.
---
 docs/conf.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/docs/conf.py b/docs/conf.py
index f37fc32f6160..01280c6cd214 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -258,6 +258,16 @@
 epub_exclude_files = ['search.html']
 
 
+# -- Read the Docs Specific Configuration
+# Define the canonical URL if you are using a custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
+
 # -- Extension configuration -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------