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

consideRatio · web-flow · commit bbc38ca286ac · 2024-07-17T18:52:33.000+02:00
RTD custom domain changes
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
 #

Original file line number	Diff line number	Diff line change
`@@ -205,6 +205,14 @@ def parse_schema(d, md=[], depth=0, pre=""):`
`205`	`205`	`}`
`206`	`206`
`207`	`207`
	`208`	`+# -- Readthedocs specific configuration -------------------------------------------`
	`209`	`+# ref: https://about.readthedocs.com/blog/2024/07/addons-by-default/`
	`210`	`+#`
	`211`	`+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")`
	`212`	`+if os.environ.get("READTHEDOCS", "") == "True":`
	`213`	`+ html_context["READTHEDOCS"] = True`
	`214`	`+`
	`215`	`+`
`208`	`216`	`# -- Options for linkcheck builder -------------------------------------------`
`209`	`217`	`# ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder`
`210`	`218`	`#`