Skip to content

Use sphinxext-opengraph to generate OpenGraph metadata #953

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 13 commits into from
Nov 30, 2022
Merged

Use sphinxext-opengraph to generate OpenGraph metadata #953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
508bd4c
Use sphinxext-opengraph to generate OpenGraph metadata
hugovk Oct 4, 2022
9f323a9
Merge branch 'main' into add-og-metadata
hugovk Oct 6, 2022
659a6c3
Merge branch 'main' into add-og-metadata
ezio-melotti Oct 7, 2022
3a4f655
Merge branch 'main' into add-og-metadata
ezio-melotti Oct 7, 2022
7e8173d
Merge branch 'main' into add-og-metadata
hugovk Oct 10, 2022
b919f6c
Create logo+text PNG for og:image, SVG not supported
hugovk Oct 10, 2022
d186e52
Include og:image:width and height to ensure shares of new URLs includ…
hugovk Oct 10, 2022
3b2e688
Include og:site_name, displayed for the overall site
hugovk Oct 10, 2022
5b048ea
Use relative path for ogp_image
hugovk Oct 11, 2022
edd71a7
Use sphinxext-opengraph 0.7.1+ to use meta og:description as meta des…
hugovk Nov 2, 2022
d3c69f7
Merge branch 'main' into add-og-metadata
hugovk Nov 2, 2022
684dff2
Add theme colour using Python blue
hugovk Nov 4, 2022
e47cc4f
Regenerate OG image with Flux Regular
hugovk Nov 28, 2022
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
Binary file added _static/og-image.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx_copybutton',
'sphinxext.opengraph',
'sphinxext.rediraffe',
]

Expand Down Expand Up @@ -104,6 +105,16 @@

todo_include_todos = True

# sphinxext-opengraph config
ogp_site_url = "https://devguide.python.org/"
ogp_site_name = "Python Developer's Guide"
ogp_image = "_static/og-image.png"
ogp_custom_meta_tags = [
'<meta property="og:image:width" content="1200">',
'<meta property="og:image:height" content="630">',
'<meta name="theme-color" content="#3776ab" />',
Copy link
Member

Choose a reason for hiding this comment

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

FWIW I looked into using a gradient that matches both colors of the Python logo, but this doesn't seem supported.

]

# Strip the dollar prompt when copying code
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#strip-and-configure-input-prompts-for-code-cells
copybutton_prompt_text = "$"
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ Sphinx==5.3.0
furo>=2022.6.4
sphinx_copybutton>=0.3.3
sphinx-lint==0.6.7
sphinxext-opengraph>=0.7.1
sphinxext-rediraffe