From 9fba7eaa8f90561ab9d13cbd0fde54dd50b0266d Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Wed, 25 Sep 2024 12:43:39 -0400 Subject: [PATCH] build: Manually pull some RTD Context. See https://about.readthedocs.com/blog/2024/07/addons-by-default/ for details but essentially RTD is changing how it's building docs and this will let us handle the change gracefully. --- oeps/conf.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/oeps/conf.py b/oeps/conf.py index 920c0a161..34d7646b9 100644 --- a/oeps/conf.py +++ b/oeps/conf.py @@ -345,3 +345,13 @@ ), } +# -- Read the Docs Specific Configuration +# Define the canonical URL if you are using a custom domain on Read the Docs +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": + if "html_context" not in globals(): + html_context = {} + html_context["READTHEDOCS"] = True +