From 445061fb9f5780237453b1030d22cb2feb28e12f Mon Sep 17 00:00:00 2001 From: anon Date: Thu, 5 Nov 2026 16:12:04 +0100 Subject: [PATCH] docs: link previews with the site's PNG card and a full-sentence home page description --- docs/conf.py | 9 ++++++++- docs/index.md | 4 ++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 0aa275b..7553d14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,6 +62,13 @@ def setup(app): intersphinx_mapping = intersphinx() ogp_social_cards = {"enable": False} # needs matplotlib, and the pages have no card artwork +# Link previews (Slack, X): the site's PNG social card, since previews don't render the SVG logo, and descriptions +# sized for previews. twitter:card isn't emitted by sphinxext-opengraph, so it goes in as a custom tag. +ogp_site_url = "https://spatialdata-db.readthedocs.io/en/latest/" +ogp_image = f"{SITE_URL}/og.png" # the site's card; on www once SITE_URL moves there +ogp_image_alt = "The SpatialData-DB logo and name" +ogp_description_length = 150 +ogp_custom_meta_tags = [''] xref_overrides = {"pandas.core.series.Series": "pandas.Series"} nitpick_ignore = [ # Internal classes that appear in signatures but are not exported from `sddb`. @@ -75,7 +82,7 @@ def setup(app): ("py:class", "integer -- return first index of value."), ] -html_logo = "_static/logo.svg" # og:image and the fallback; the sidebar shows the wordmarks below +html_logo = "_static/logo.svg" # the sidebar fallback (og:image is ogp_image above); the sidebar shows the wordmarks below html_favicon = "_static/logo.svg" html_static_path = ["_static"] html_css_files = ["css/sddb.css"] diff --git a/docs/index.md b/docs/index.md index f943a17..a2ed2b4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +og:description: A catalog of public spatial omics datasets as SpatialData Zarr stores, with a Python client to query, download and load them. +--- + # spatialdata-db: spatial omics datasets as SpatialData spatialdata-db is a catalog of public spatial omics datasets, from Visium and Xenium to MERSCOPE, CosMx and mass spectrometry imaging.