From: Ben Darnell <ben@bendarnell.com>
Date: Wed, 4 Sep 2024 19:14:30 +0000 (-0400)
Subject: docs: Add readthedocs configuration
X-Git-Tag: v6.5.0b1~37^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F3420%2Fhead;p=thirdparty%2Ftornado.git

docs: Add readthedocs configuration

RTD will no longer do this automagically, so we need to add these
lines explicitly for compatibility. See
https://about.readthedocs.com/blog/2024/07/addons-by-default/
---

diff --git a/docs/conf.py b/docs/conf.py
index bb370587..c2c81b5f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -146,3 +146,16 @@ def missing_reference_handler(app, env, node, contnode):
 
 def setup(app):
     app.connect("missing-reference", missing_reference_handler)
+
+
+# Read the Docs configuration updates from
+# https://about.readthedocs.com/blog/2024/07/addons-by-default/
+
+# 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