MNT: Add rtd required code blocks.

hyriver · Oct 6, 2024 · 6e82ae1 · 6e82ae1
1 parent d724ccc
commit 6e82ae1
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -35,7 +35,14 @@
     "pynldas2": "PyNLDAS2",
     "hydrosignatures": "HydroSignatures",
 }
-
+# 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
 # -- General configuration ---------------------------------------------------
 
 extensions = [