Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Use sphinxext-opengraph to generate OpenGraph metadata (#99931) 

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Hugo van Kemenade 2022-12-05 23:26:28 +02:00 committed by GitHub
parent d8ab0a4dfa
commit f49c735e52
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 33 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Doc/_static/og-image.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

34
Doc/conf.py
View File

@ -13,9 +13,25 @@ sys.path.append(os.path.abspath('includes'))
# General configuration # General configuration
# --------------------- # ---------------------
extensions = ['sphinx.ext.coverage', 'sphinx.ext.doctest', extensions = [
'pyspecific', 'c_annotations', 'escape4chm', 'asdl_highlight',
'asdl_highlight', 'peg_highlight', 'glossary_search'] '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 = ''' doctest_global_setup = '''
try: try:
@ -114,7 +130,7 @@ html_additional_pages = {
html_use_opensearch = 'https://docs.python.org/' + version html_use_opensearch = 'https://docs.python.org/' + version
# Additional static files. # Additional static files.
html_static_path = ['tools/static'] html_static_path = ['_static', 'tools/static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'python' + release.replace('.', '') htmlhelp_basename = 'python' + release.replace('.', '')
@ -238,3 +254,13 @@ linkcheck_ignore = [r'https://bugs.python.org/(issue)?\d+']
# Relative filename of the data files # Relative filename of the data files
refcount_file = 'data/refcounts.dat' refcount_file = 'data/refcounts.dat'
stable_abi_file = 'data/stable_abi.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
Doc/requirements.txt
View File

@ -8,6 +8,7 @@ sphinx==4.5.0
blurb blurb
sphinx-lint==0.6.7 sphinx-lint==0.6.7
sphinxext-opengraph>=0.7.1
# The theme used by the documentation is stored separately, so we need # The theme used by the documentation is stored separately, so we need
# to install that as well. # to install that as well.

2
Misc/NEWS.d/next/Documentation/2022-12-02-17-08-08.gh-issue-99931.wC46hE.rst Normal file
View File

@ -0,0 +1,2 @@
Use `sphinxext-opengraph <https://sphinxext-opengraph.readthedocs.io/>`__
to generate `OpenGraph metadata <https://ogp.me/>`__.