Infra: Add OG metadata to improve previews of shared links #3707
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think because this is a custom theme, for some reason the sphinxext-opengraph we use for CPython docs and the devguide doesn't work here.
But it's easy enough to add the Open Graph metadata to the template header, omitting the longer
<meta name="description" content="...">that sphinxext-opengraph generates.OG docs: https://ogp.me/
Demo
On Discord, with a temporary build using
<meta property="og:image" content="https://docs.python.org/3/_static/og-image.png">, becausehttps://peps.python.org/_static/og-image.pngisn't deployed yet.Currently
📚 Documentation preview 📚: https://pep-previews--3707.org.readthedocs.build/