Skip to content

GH-136155: Use sphinxext-opengraph v0.12.0 #137393

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 5 commits into from
Aug 5, 2025
Merged

GH-136155: Use sphinxext-opengraph v0.12.0 #137393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8964ce4
Use ``sphinxext-opengraph`` v0.12.0
AA-Turner Aug 4, 2025
d8bb086
Revert "gh-136155: Docs: only add custom OpenGraph protocol meta tags…
AA-Turner Aug 5, 2025
b1261e3
Fix ogp_custom_meta_tags type warning
AA-Turner Aug 5, 2025
86a3631
format
AA-Turner Aug 5, 2025
5dd4c43
Merge branch 'main' into docs/opengraph-0.12
hugovk Aug 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
19 changes: 8 additions & 11 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,14 +567,11 @@
'image': '_static/og-image.png',
'line_color': '#3776ab',
}
if 'builder_html' in tags: # noqa: F821
ogp_custom_meta_tags = [
'<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">',
]
ogp_custom_meta_tags = ('<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.11.0
sphinxext-opengraph~=0.12.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does sphinxext-opengraph use SemVer?

If so, it's definitely used in production, time for 1.0.0 🚀

https://semver.org/#how-do-i-know-when-to-release-100

sphinx-notfound-page~=1.0.0

# The theme used by the documentation is stored separately, so we need
Expand Down
1 change: 0 additions & 1 deletion Misc/NEWS.d/next/Documentation/2025-07-01-21-04-47.gh-issue-136155.ufmH4Q.rst
View file
Open in desktop

This file was deleted.

Loading