Skip to content
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.

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

Use sphinxext-opengraph to generate OpenGraph metadata #99931

Merged
merged 7 commits into from
Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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 Doc/_static/og-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 30 additions & 4 deletions Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,25 @@
# General configuration
# ---------------------

extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest',
'pyspecific', 'c_annotations', 'escape4chm',
'asdl_highlight', 'peg_highlight', 'glossary_search']
extensions = [
'asdl_highlight',
'c_annotations',
'escape4chm',
'glossary_search',
'peg_highlight',
'pyspecific',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
]

# Skip if downstream redistributors haven't installed it
try:
import sphinxext.opengraph
except ImportError:
pass
else:
extensions.append('sphinxext.opengraph')


doctest_global_setup = '''
try:
Expand Down Expand Up @@ -114,7 +130,7 @@
html_use_opensearch = 'https://docs.python.org/' + version

# Additional static files.
html_static_path = ['tools/static']
html_static_path = ['_static', 'tools/static']

# Output file base name for HTML help builder.
htmlhelp_basename = 'python' + release.replace('.', '')
Expand Down Expand Up @@ -238,3 +254,13 @@
# Relative filename of the data files
refcount_file = 'data/refcounts.dat'
stable_abi_file = 'data/stable_abi.dat'

# sphinxext-opengraph config
ogp_site_url = 'https://docs.python.org/3/'
ogp_site_name = 'Python documentation'
ogp_image = '_static/og-image.png'
ogp_custom_meta_tags = [
'<meta property="og:image:width" content="200">',
'<meta property="og:image:height" content="200">',
'<meta name="theme-color" content="#3776ab">',
]
1 change: 1 addition & 0 deletions Doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ sphinx==4.5.0
blurb

sphinx-lint==0.6.7
sphinxext-opengraph>=0.7.1

# The theme used by the documentation is stored separately, so we need
# to install that as well.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Use `sphinxext-opengraph <https://sphinxext-opengraph.readthedocs.io/>`__
to generate `OpenGraph metadata <https://ogp.me/>`__.
hugovk marked this conversation as resolved.
Show resolved Hide resolved