summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
index c9138a5a5d4..ced3a6723fc 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -21,6 +21,14 @@ from subprocess import check_output
# Get Sphinx version
major, minor, patch = sphinx.version_info[:3]
+# 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,
+ }
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the