Merge pull request #3461 from manics/rtd-custom-domains

RTD custom domain changes
jupyterhub · Jul 17, 2024 · bbc38ca · bbc38ca
2 parents fd6fff1 + 2425412
commit bbc38ca
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -205,6 +205,14 @@ def parse_schema(d, md=[], depth=0, pre=""):
 }
 
 
+# -- Readthedocs specific configuration -------------------------------------------
+# ref: https://about.readthedocs.com/blog/2024/07/addons-by-default/
+#
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+if os.environ.get("READTHEDOCS", "") == "True":
+    html_context["READTHEDOCS"] = True
+
+
 # -- Options for linkcheck builder -------------------------------------------
 # ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
 #