sphinxext-opengraph
Sphinx Extension to enable OGP support
Decision gist · record as of 2026-08-14
Yes. Low install friction, permissive license, no known vulnerabilities, and stable maintenance make this a safe choice for any Sphinx documentation project that needs social media preview support. The aging status reflects infrequent updates rather than abandonment—the repository is active and the extension is production-stable.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and a Sphinx documentation project already configured.
- Low friction install with a single runtime dependency on Sphinx.
- Marked as aging (350 days since last release), but the repository remains active with recent commits and is not archived, suggesting stable maintenance rather than abandonment.
License · maintenance · safety
BSD-3-Clause (permissive) — BSD-3-Clause is a permissive license with minimal restrictions; you can use this package freely in commercial and private projects with only attribution required.
last release 2025-08-29 (350 days) · last repo commit 2025-08-29 · 91 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 743,864 downloads/mo, #5,175 on PyPI
Alternatives
Verify before relying
pip install sphinxext-opengraph
# In conf.py:
extensions = ['sphinxext.opengraph']
ogp_social_cards = {
"enable": True,
}- Whether the social-cards extra requires additional system dependencies beyond what pip installs
- Performance impact when generating metadata for large documentation sites
What it is and what it does
sphinxext-opengraph is a Sphinx extension that injects Open Graph protocol metadata into the HTML head of each documentation page during the build process. When documentation links are shared on social platforms like Twitter, Facebook, or LinkedIn, these metadata tags control how the preview appears—including title, description, and image.
The extension integrates directly into Sphinx's build pipeline and requires only Sphinx as a runtime dependency. It supports an optional social-cards extra for generating custom preview images. The package is stable, supports Python 3.9 through 3.14, and has been in production use since 2020.
Use it for
- Ensure API documentation links display properly formatted previews when shared in team chat or social media.
- Generate custom social card images for documentation pages to improve visual consistency in link previews.
- Add structured metadata to technical documentation so search engines and social platforms extract correct titles and descriptions.
- Automate Open Graph tag generation across a large multi-page documentation site without manual HTML editing.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
Low install friction, permissive license, no known vulnerabilities, and stable maintenance make this a safe choice for any Sphinx documentation project that needs social media preview support. The aging status reflects infrequent updates rather than abandonment—the repository is active and the extension is production-stable.
Install
sphinxext-opengraph on PyPI
Before you install
Low friction install with a single runtime dependency on Sphinx. Marked as aging (350 days since last release), but the repository remains active with recent commits and is not archived, suggesting stable maintenance rather than abandonment.
Requires Sphinx to be installed and a Sphinx documentation project already configured.
License in practice
BSD-3-Clause is a permissive license with minimal restrictions; you can use this package freely in commercial and private projects with only attribution required.
Quickstart
pip install sphinxext-opengraph
# In conf.py:
extensions = ['sphinxext.opengraph']
ogp_social_cards = {
"enable": True,
}Verify before relying
- Whether the social-cards extra requires additional system dependencies beyond what pip installs
- Performance impact when generating metadata for large documentation sites
Package facts
| License | BSD-3-Clause permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packageSphinx |
| Maintenance | Aging 350 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 743,864 / month, #5,175 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: PluginsEnvironment :: Web EnvironmentFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersNatural Language :: EnglishOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Programming Language :: Python :: 3.9Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: DocumentationTopic :: Text ProcessingTopic :: Utilities |
Evidence: sphinxext_opengraph-0.13.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx open graph metadata”
- sphinxext-opengraphSphinx extension that automatically generates Open Graph metadata…
- extructExtracts structured metadata from HTML markup in multiple formats:…
- sphinx-autobuildWatches Sphinx documentation source files for changes and…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also linkpreview · sphinx-reredirects · sphinx-automodapi · sphinx-favicon · sphinx-hoverxref · sphinxext-rediraffe · sphinxcontrib-images · sphinx_design · neoteroi-mkdocs · extruct