Factor out read_the_docs_site_url()

wpilibsuite · Jan 30, 2025 · 27c8f79 · 27c8f79
1 parent 43d177c
commit 27c8f79
Showing 1 changed file with 26 additions and 22 deletions.
diff --git a/sphinxext/opengraph/__init__.py b/sphinxext/opengraph/__init__.py
@@ -3,7 +3,7 @@
 import os
 from pathlib import Path
 from typing import TYPE_CHECKING
-from urllib.parse import urljoin, urlparse, urlsplit, urlunparse
+from urllib.parse import urljoin, urlparse, urlsplit, urlunsplit
 
 import docutils.nodes as nodes
 
@@ -100,27 +100,7 @@ def get_tags(
     tags["og:type"] = config.ogp_type
 
     if not config.ogp_site_url and os.getenv("READTHEDOCS"):
-        if config.html_baseurl is not None:
-            # readthedocs uses ``html_baseurl`` for Sphinx > 1.8
-            parse_result = urlsplit(config.html_baseurl)
-        else:
-            # readthedocs addons no longer configures ``html_baseurl``
-            if rtd_canonical_url := os.getenv("READTHEDOCS_CANONICAL_URL"):
-                parse_result = urlsplit(rtd_canonical_url)
-            else:
-                raise OSError("ReadTheDocs did not provide a valid canonical URL!")
-
-        # Grab root url from canonical url
-        config.ogp_site_url = urlunparse(
-            (
-                parse_result.scheme,
-                parse_result.netloc,
-                parse_result.path,
-                "",
-                "",
-                "",
-            )
-        )
+        config.ogp_site_url = read_the_docs_site_url(config.html_baseurl)
 
     # url tag
     # Get the URL of the specific page
@@ -248,6 +228,30 @@ def get_tags(
     )
 
 
+def read_the_docs_site_url(html_baseurl: str | None) -> str:
+    if html_baseurl is not None:
+        # readthedocs uses ``html_baseurl`` for Sphinx > 1.8
+        parse_result = urlsplit(html_baseurl)
+    else:
+        # readthedocs addons no longer configures ``html_baseurl``
+        if rtd_canonical_url := os.getenv("READTHEDOCS_CANONICAL_URL"):
+            parse_result = urlsplit(rtd_canonical_url)
+        else:
+            raise OSError("ReadTheDocs did not provide a valid canonical URL!")
+
+    # Grab root url from canonical url
+    return urlunsplit(
+        (
+            parse_result.scheme,
+            parse_result.netloc,
+            parse_result.path,
+            "",
+            "",
+            "",
+        )
+    )
+
+
 def social_card_for_page(
     config_social: dict[str, bool | str],
     site_name: str,