Skip to content

Generate social media preview cards for the documentation #132101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 5, 2025
Merged

Generate social media preview cards for the documentation #132101

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
abb4a2c
Generate social media cards per page
hugovk Jan 7, 2023
a58e876
Use the create-social-cards tag
AA-Turner Jan 20, 2025
a5844c0
Remove ``social_previews`` folder before archiving
AA-Turner Jan 20, 2025
ed89576
Use new ogp_canonical_url setting
AA-Turner Apr 4, 2025
32dd018
Require sphinxext-opengraph 0.10
AA-Turner Apr 4, 2025
9533953
TMP: --tag create-social-cards
AA-Turner Apr 4, 2025
c35a833
Revert "TMP: --tag create-social-cards"
AA-Turner Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ build:
echo ""; \
exit 1; \
fi
$(SPHINXBUILD) $(ALLSPHINXOPTS)
$(SPHINXBUILD) $(ALLSPHINXOPTS) --tag create-social-cards
@echo

.PHONY: html
Expand Down Expand Up @@ -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)
Expand Down
16 changes: 12 additions & 4 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,11 +624,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 = [
'<meta property="og:image:width" content="200" />',
'<meta property="og:image:height" content="200" />',
'<meta name="theme-color" content="#3776ab" />',
]
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 += [
'<meta property="og:image:width" content="200" />',
'<meta property="og:image:height" content="200" />',
]
2 changes: 1 addition & 1 deletion Doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sphinx~=8.2.0

blurb

sphinxext-opengraph~=0.9.0
sphinxext-opengraph[social-cards]~=0.10.0
sphinx-notfound-page~=1.0.0

# The theme used by the documentation is stored separately, so we need
Expand Down
Loading