From e5c165c756354b7afd997d72706fa9065e1a3be2 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 5 Apr 2025 15:20:06 +0100 Subject: [PATCH] [3.13] Generate social media preview cards for the documentation (GH-132101) (cherry picked from commit 561965fa5c8314dee5b86586ffa16c1f369d1fa2) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade --- Doc/Makefile | 1 + Doc/conf.py | 16 ++++++++++++---- Doc/requirements.txt | 2 +- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/Doc/Makefile b/Doc/Makefile index b8896da4a91869..c8a749a02a89ec 100644 --- a/Doc/Makefile +++ b/Doc/Makefile @@ -204,6 +204,7 @@ dist-html: find dist -name 'python-$(DISTVERSION)-docs-html*' -exec rm -rf {} \; $(MAKE) html cp -pPR build/html dist/python-$(DISTVERSION)-docs-html + rm -rf dist/python-$(DISTVERSION)-docs-html/_images/social_previews/ tar -C dist -cf dist/python-$(DISTVERSION)-docs-html.tar python-$(DISTVERSION)-docs-html bzip2 -9 -k dist/python-$(DISTVERSION)-docs-html.tar (cd dist; zip -q -r -9 python-$(DISTVERSION)-docs-html.zip python-$(DISTVERSION)-docs-html) diff --git a/Doc/conf.py b/Doc/conf.py index c73a4d09617f79..022553b5ff5580 100644 --- a/Doc/conf.py +++ b/Doc/conf.py @@ -616,11 +616,19 @@ # Options for sphinxext-opengraph # ------------------------------- -ogp_site_url = 'https://docs.python.org/3/' +ogp_canonical_url = 'https://docs.python.org/3/' ogp_site_name = 'Python documentation' -ogp_image = '_static/og-image.png' +ogp_social_cards = { # Used when matplotlib is installed + 'image': '_static/og-image.png', + 'line_color': '#3776ab', +} 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/Doc/requirements.txt b/Doc/requirements.txt index 2e429f46b43408..a2960ea9aa0203 100644 --- a/Doc/requirements.txt +++ b/Doc/requirements.txt @@ -11,7 +11,7 @@ sphinx~=8.2.0 blurb -sphinxext-opengraph~=0.9.0 +sphinxext-opengraph~=0.10.0 sphinx-notfound-page~=1.0.0 # The theme used by the documentation is stored separately, so we need