Add OpenGraph metadata

pyinat · Dec 11, 2023 · 3e6e088 · 3e6e088
1 parent ea06dbd
commit 3e6e088
Show file tree

Hide file tree

Showing 3 changed files with 841 additions and 307 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,6 +66,7 @@
     'sphinx_copybutton',
     'sphinx_design',
     'sphinxcontrib.apidoc',
+    'sphinxext.opengraph',
     'myst_parser',
     'nbsphinx',
 ]
@@ -148,6 +149,12 @@
 autosummary_imported_members = False
 numpydoc_show_class_members = False
 
+# OpenGraph settings
+ogp_site_url = 'https://pyinaturalist.readthedocs.io'
+ogp_image = (
+    'https://raw.githubusercontent.com/pyinat/pyinaturalist/main/docs/images/python-logo-green.png'
+)
+
 # HTML general settings
 html_static_path = ['_static']
 html_favicon = join('_static', 'favicon.ico')