Add OpenGraph metadata for better social sharing previews, check preview image once online! (otherwise need to change to png instead of svg

floriankozikowski · floriankozikowski · commit 967c0e22286c · 2025-04-16T16:49:58.000+02:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -102,6 +102,14 @@
 
 html_baseurl = 'https://contrib.scikit-learn.org/skglm/'
 
+extensions.append("sphinxext.opengraph")
+
+# OpenGraph config
+ogp_site_url = html_baseurl
+ogp_image = "https://contrib.scikit-learn.org/skglm/_static/images/logo.svg"
+ogp_description_length = 250
+ogp_type = "website"
+
 
 # -- Options for HTML output ----------------------------------------------
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -67,6 +67,7 @@ doc = [
     "lifelines",
     "pydata_sphinx_theme",
     "sphinx-sitemap",
+    "sphinxext-opengraph",
 ]
 
 
