From 8964ce43cf264b0c2286305ab61b10c940aeff4e Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Mon, 4 Aug 2025 22:55:41 +0100
Subject: [PATCH 1/4] Use ``sphinxext-opengraph`` v0.12.0
---
Doc/requirements.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Doc/requirements.txt b/Doc/requirements.txt
index 924e218c9f67d9..7b7286429a1041 100644
--- a/Doc/requirements.txt
+++ b/Doc/requirements.txt
@@ -11,7 +11,7 @@ sphinx~=8.2.0
blurb
-sphinxext-opengraph~=0.11.0
+sphinxext-opengraph~=0.12.0
sphinx-notfound-page~=1.0.0
# The theme used by the documentation is stored separately, so we need
From d8bb0865845134008595368a57038125665db6c4 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Tue, 5 Aug 2025 15:25:57 +0100
Subject: [PATCH 2/4] Revert "gh-136155: Docs: only add custom OpenGraph
protocol meta tags for HTML builds (#136187)"
This reverts commit c45da6ae16a0bc796e880c9dbcd4f643345b03b7.
---
Doc/conf.py | 19 +++++++++----------
...-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst | 1 -
2 files changed, 9 insertions(+), 11 deletions(-)
delete mode 100644 Misc/NEWS.d/next/Documentation/2025-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst
diff --git a/Doc/conf.py b/Doc/conf.py
index 1c1f36e5bc0737..b696c4742e8cba 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -567,14 +567,13 @@
'image': '_static/og-image.png',
'line_color': '#3776ab',
}
-if 'builder_html' in tags: # noqa: F821
- ogp_custom_meta_tags = [
- '',
+ogp_custom_meta_tags = [
+ '',
+]
+if 'create-social-cards' not in tags: # noqa: F821
+ # Define a static preview image when not creating social cards
+ ogp_image = '_static/og-image.png'
+ ogp_custom_meta_tags += [
+ '',
+ '',
]
- if 'create-social-cards' not in tags: # noqa: F821
- # Define a static preview image when not creating social cards
- ogp_image = '_static/og-image.png'
- ogp_custom_meta_tags += [
- '',
- '',
- ]
diff --git a/Misc/NEWS.d/next/Documentation/2025-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst b/Misc/NEWS.d/next/Documentation/2025-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst
deleted file mode 100644
index 0341b5f7f0d5e6..00000000000000
--- a/Misc/NEWS.d/next/Documentation/2025-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst
+++ /dev/null
@@ -1 +0,0 @@
-EPUB builds are fixed by excluding non-XHTML-compatible tags.
From b1261e30a2f399bd023c618ba6b55c95187dad43 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Tue, 5 Aug 2025 15:37:18 +0100
Subject: [PATCH 3/4] Fix ogp_custom_meta_tags type warning
---
Doc/conf.py | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Doc/conf.py b/Doc/conf.py
index b696c4742e8cba..1eaf7eeafa90ca 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -567,13 +567,13 @@
'image': '_static/og-image.png',
'line_color': '#3776ab',
}
-ogp_custom_meta_tags = [
+ogp_custom_meta_tags = (
'',
-]
+)
if 'create-social-cards' not in tags: # noqa: F821
# Define a static preview image when not creating social cards
ogp_image = '_static/og-image.png'
- ogp_custom_meta_tags += [
+ ogp_custom_meta_tags += (
'',
'',
- ]
+ )
From 86a3631bbef37ca53b7a1ddb0128b9b5d3f630cc Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Tue, 5 Aug 2025 16:33:16 +0100
Subject: [PATCH 4/4] format
---
Doc/conf.py | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/Doc/conf.py b/Doc/conf.py
index 1eaf7eeafa90ca..35e0b3eaeafe94 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -567,9 +567,7 @@
'image': '_static/og-image.png',
'line_color': '#3776ab',
}
-ogp_custom_meta_tags = (
- '',
-)
+ogp_custom_meta_tags = ('',)
if 'create-social-cards' not in tags: # noqa: F821
# Define a static preview image when not creating social cards
ogp_image = '_static/og-image.png'