Update conf.py

As suggestet at https://about.readthedocs.com/blog/2024/07/addons-by-default/

Update conf.py
As suggestet at https://about.readthedocs.com/blog/2024/07/addons-by-default/
a494f8af · Michael Howitz · GitHub · d698507b · a494f8af
Commit a494f8af authored Jul 17, 2024 by Michael Howitz Committed by GitHub Jul 17, 2024
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 0 deletions

docs/conf.py docs/conf.py +7 -0

No files found.
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -26,6 +26,13 @@ import datetime
 sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath(".."))

+# Define the canonical URL to use custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+html_context = {}
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    html_context["READTHEDOCS"] = True

 # General configuration
 # ---------------------