Merge pull request #258 from openedx/feanil/update_rtd_config

build: Manually pull some RTD Context.
openedx · Sep 27, 2024 · c44c3d5 · c44c3d5
2 parents 4020cd2 + ac5646a
commit c44c3d5
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -107,3 +107,14 @@
 
 # -- Options for autosummary extension ---------------------------------------
 autosummary_imported_members = True
+
+# -- 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
+