From b83490d95d9d6d269a408c66247dee264d243e82 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Wed, 25 Sep 2024 13:00:45 -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. --- docs/conf.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index fabefb96e..8d9e225e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -285,3 +285,14 @@ None, ), } + +# -- 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 +