doc: update sphinx configs for RTD changes

Read The Docs made some changes that require us to add some configuration in our build config files. Signed-off-by: Quentin Young <[email protected]>
FRRouting · Aug 21, 2024 · 95d9bf1 · 95d9bf1
1 parent e2d6356
commit 95d9bf1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/doc/developer/conf.py b/doc/developer/conf.py
@@ -66,6 +66,13 @@
 # The full version, including alpha/beta/rc tags.
 release = u"?.?-?"
 
+# 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.

diff --git a/doc/user/conf.py b/doc/user/conf.py
@@ -65,6 +65,16 @@
 # The full version, including alpha/beta/rc tags.
 release = u"?.?-?"
 
+# 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.