Merge pull request #792 from openedx/feanil/update_rtd_config

build: Manually pull some RTD Context.
openedx · Sep 26, 2024 · ded9541 · ded9541
2 parents e23f55a + b83490d
commit ded9541
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -285,3 +285,14 @@
         None,
     ),
 }
+
+# -- 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
+