Skip to content

[WIP] feature: add config option to copy property og description #147

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

Draft
AnneCYH wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

[WIP] feature: add config option to copy property og description #147

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4209655
feature: add config option to copy property og description
AnneCYH Dec 12, 2025
c86edb9
feature: fix test logic
AnneCYH Dec 12, 2025
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
24 changes: 19 additions & 5 deletions sphinxext/opengraph/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,24 @@ def get_tags(
tags['og:site_name'] = site_name

# description tag
if description:
og_description = fields.get('og:description')
if og_description:
tags['og:description'] = og_description
if description and not og_description:
tags['og:description'] = description

if config.ogp_enable_meta_description and not get_meta_description(
context['metatags']
):
meta_tags['description'] = description
# Check for meta description override
meta_description_exists = get_meta_description(context['metatags'])
if og_description and not meta_description_exists:
meta_tags['description'] = og_description
elif (
config.ogp_enable_meta_description
and not meta_description_exists
and description
and not og_description
and getattr(config, 'ogp_copy_og_description_to_meta', False)
):
meta_tags['description'] = description

# image tag
# Get basic values from config
Expand Down Expand Up @@ -357,6 +368,9 @@ def setup(app: Sphinx) -> ExtensionMetadata:
app.add_config_value(
'ogp_enable_meta_description', True, 'html', types=frozenset({bool})
)
app.add_config_value(
'ogp_copy_og_description_to_meta', False, 'html', types=frozenset({bool})
)

# Main Sphinx OpenGraph linking
app.connect('html-page-context', html_page_context)
Expand Down
Loading