📚 DOCS: Add opengraph extension (#393)

choldgraf · web-flow · commit 547eb261277c · 2021-06-14T09:54:04.000-07:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,6 +28,7 @@
     "sphinx.ext.viewcode",
     "sphinxcontrib.bibtex",
     "sphinx_panels",
+    "sphinxext.opengraph",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55,6 +56,10 @@
     "repository_branch": "master",
     "path_to_docs": "docs",
 }
+# OpenGraph metadata
+ogp_site_url = "https://myst-parser.readthedocs.io/en/latest"
+# This is the image that GitHub stores for our social media previews
+ogp_image = "https://repository-images.githubusercontent.com/240151150/316bc480-cc23-11eb-96fc-4ab2f981a65d"  # noqa: E501
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
diff --git a/setup.cfg b/setup.cfg
@@ -63,6 +63,7 @@ rtd =
     sphinx-book-theme~=0.1.0
     sphinx-panels~=0.5.2
     sphinxcontrib-bibtex~=2.1
+    sphinxext-opengraph~=0.4.2
 # left in for back-compatability
 sphinx =
 testing =
