add open graph metadata to docs

Author: rmorshea

docs/source/conf.py

@@ -26,6 +26,12 @@
 # -- Project information -----------------------------------------------------
 
 project = "IDOM"
+title = "IDOM Docs"
+description = (
+    "IDOM is a Python web framework for building interactive websites without needing "
+    "a single line of Javascript. It can be run standalone, in a Jupyter Notebook, or "
+    "as part of an existing application."
+)
 copyright = "2020, Ryan Morshead"
 author = "Ryan Morshead"
 
@@ -74,6 +80,7 @@
     "sphinx_copybutton",
     "sphinx_reredirects",
     "sphinx_design",
+    "sphinxext.opengraph",
     # custom extensions
     "async_doctest",
     "autogen_api_docs",
@@ -126,10 +133,12 @@
 
 # -- Extension Configuration ------------------------------------------------------
 
+
 # -- sphinx.ext.autosectionlabel ---
 
 autosectionlabel_skip_docs = ["_auto/apis"]
 
+
 # -- sphinx.ext.autodoc --
 
 # show base classes for autodoc
@@ -140,6 +149,7 @@
 # order autodoc members by their order in the source
 autodoc_member_order = "bysource"
 
+
 # -- sphinx_reredirects --
 
 redirects = {
@@ -148,10 +158,29 @@
     "examples": "creating-interfaces/index.html",
 }
 
+
+# -- sphinxext.opengraph --
+
+ogp_site_url = "https://idom-docs.herokuapp.com/"
+ogp_image = "https://raw.githubusercontent.com/idom-team/idom/main/branding/png/idom-logo-black.png"
+# We manually specify this below
+# ogp_description_length = 200
+ogp_type = "website"
+ogp_custom_meta_tags = [
+    # Open Graph Meta Tags
+    f'<meta property="og:title" content="{title}">',
+    f'<meta property="og:description" content="{description}">',
+    # Twitter Meta Tags
+    f'<meta name="twitter:card" content="summary_large_image">',
+    f'<meta name="twitter:creator" content="@rmorshea">',
+    f'<meta name="twitter:site" content="@rmorshea">',
+]
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # Set the page title
-html_title = "IDOM Docs"
+html_title = title
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.

requirements/build-docs.txt

@@ -7,3 +7,4 @@ sphinx-autobuild ==2020.9.1
 sphinx-reredirects ==0.0.1
 sphinx-design ==0.0.13
 sphinx-resolve-py-references ==0.1.0
+sphinxext-opengraph ==0.5.1