summaryrefslogtreecommitdiff
path: root/doc/user/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user/conf.py')
-rw-r--r--doc/user/conf.py10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/user/conf.py b/doc/user/conf.py
index 18f048bc08..236a90e902 100644
--- a/doc/user/conf.py
+++ b/doc/user/conf.py
@@ -67,6 +67,16 @@ version = "?.?"
# The full version, including alpha/beta/rc tags.
release = "?.?-?"
+# RTD configuration
+
+# Set canonical URL from the Read the Docs Domain
+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":
+ html_context["READTHEDOCS"] = True
+
+
# -----------------------------------------------------------------------------
# Extract values from codebase for substitution into docs.