Use canonicals on ReadTheDocs

tomschr · tomschr · commit 87f639f9edd4 · 2023-10-09T15:26:40.000+02:00
If environment variable READTHEDOCS_CANONICAL_URL is
definied, set html_baseurl variable so Sphinx can
grab it.
diff --git a/docs/conf.py b/docs/conf.py
@@ -211,6 +211,10 @@ def find_version(*file_paths):
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 
+# Canonical link relation
+if os.environ.get("READTHEDOCS_CANONICAL_URL"):
+    html_baseurl = f"{os.environ['READTHEDOCS_CANONICAL_URL']}"
+
 # html_logo = "logo.svg"
 
 # -- Options for HTMLHelp output ------------------------------------------
