Add Open Graph protocol support for documentation link previews

laughingman7743 · claude · laughingman7743 · commit 541ec1228959 · 2026-02-08T15:09:47.000+09:00
- Add sphinxext-opengraph dependency
- Configure OGP with site URL, logo_square.png image, and metadata
- Enables rich previews when sharing documentation links on Slack, Twitter, etc.

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/docs/conf.py b/docs/conf.py
@@ -116,6 +116,7 @@ def setup(app):
     "sphinx.ext.intersphinx",
     "sphinx.ext.githubpages",
     "sphinx_multiversion",
+    "sphinxext.opengraph",
 ]
 
 # Napoleon settings for Google-style docstrings
@@ -187,6 +188,13 @@ def setup(app):
     ]
 }
 
+# -- Open Graph protocol settings ----------------------------------------------
+
+ogp_site_url = "https://laughingman7743.github.io/PyAthena/"
+ogp_image = "https://laughingman7743.github.io/PyAthena/_static/logo_square.png"
+ogp_description_length = 200
+ogp_type = "website"
+
 # -- Sphinx-multiversion configuration ----------------------------------------
 
 # Whitelist pattern for tags (semantic versioning: vX.Y.Z)
diff --git a/pyproject.toml b/pyproject.toml
@@ -73,6 +73,7 @@ dev = [
     "pytest-dependency",
     "sphinx",
     "sphinx-multiversion",
+    "sphinxext-opengraph",
     "furo",
     "types-python-dateutil",
 ]
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ def setup(app):`
`116`	`116`	`"sphinx.ext.intersphinx",`
`117`	`117`	`"sphinx.ext.githubpages",`
`118`	`118`	`"sphinx_multiversion",`
	`119`	`+ "sphinxext.opengraph",`
`119`	`120`	`]`
`120`	`121`
`121`	`122`	`# Napoleon settings for Google-style docstrings`
`@@ -187,6 +188,13 @@ def setup(app):`
`187`	`188`	`]`
`188`	`189`	`}`
`189`	`190`
	`191`	`+# -- Open Graph protocol settings ----------------------------------------------`
	`192`	`+`
	`193`	`+ogp_site_url = "https://laughingman7743.github.io/PyAthena/"`
	`194`	`+ogp_image = "https://laughingman7743.github.io/PyAthena/_static/logo_square.png"`
	`195`	`+ogp_description_length = 200`
	`196`	`+ogp_type = "website"`
	`197`	`+`
`190`	`198`	`# -- Sphinx-multiversion configuration ----------------------------------------`
`191`	`199`
`192`	`200`	`# Whitelist pattern for tags (semantic versioning: vX.Y.Z)`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ dev = [`
`73`	`73`	`"pytest-dependency",`
`74`	`74`	`"sphinx",`
`75`	`75`	`"sphinx-multiversion",`
	`76`	`+ "sphinxext-opengraph",`
`76`	`77`	`"furo",`
`77`	`78`	`"types-python-dateutil",`
`78`	`79`	`]`