[Python-checkins] Use sphinxext-opengraph to generate OpenGraph metadata (#99931)

Mon Dec 5 16:26:34 EST 2022

https://github.com/python/cpython/commit/f49c735e525cf031ddbfc19161aafac4fb18837b
commit: f49c735e525cf031ddbfc19161aafac4fb18837b
branch: main
author: Hugo van Kemenade <hugovk at users.noreply.github.com>
committer: hugovk <hugovk at users.noreply.github.com>
date: 2022年12月05日T23:26:28+02:00
summary:
Use sphinxext-opengraph to generate OpenGraph metadata (#99931)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach at Gerlach.CAM>
files:
A Doc/_static/og-image.png
A Misc/NEWS.d/next/Documentation/2022-12-02-17-08-08.gh-issue-99931.wC46hE.rst
M Doc/conf.py
M Doc/requirements.txt

diff --git a/Doc/_static/og-image.png b/Doc/_static/og-image.png
new file mode 100644
index 000000000000..0e80751e7403
Binary files /dev/null and b/Doc/_static/og-image.png differ
diff --git a/Doc/conf.py b/Doc/conf.py
index 6fad5c668dab..c7d2f43b7a8e 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -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:
@@ -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('.', '')
@@ -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">',
+]
diff --git a/Doc/requirements.txt b/Doc/requirements.txt
index 958665db69e2..134f39d6d7b3 100644
--- a/Doc/requirements.txt
+++ b/Doc/requirements.txt
@@ -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.
diff --git a/Misc/NEWS.d/next/Documentation/2022-12-02-17-08-08.gh-issue-99931.wC46hE.rst b/Misc/NEWS.d/next/Documentation/2022-12-02-17-08-08.gh-issue-99931.wC46hE.rst
new file mode 100644
index 000000000000..0c01a2cb2cfa
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2022-12-02-17-08-08.gh-issue-99931.wC46hE.rst
@@ -0,0 +1,2 @@
+Use `sphinxext-opengraph <https://sphinxext-opengraph.readthedocs.io/>`__
+to generate `OpenGraph metadata <https://ogp.me/>`__.
