DisnakeDev · shiftinv · Nov 4, 2022 · Nov 8, 2022 · Nov 8, 2022 · Nov 8, 2022
diff --git a/changelog/860.doc.rst b/changelog/860.doc.rst
@@ -0,0 +1 @@
+Add `OpenGraph <https://ogp.me/>`_ tags to all pages.
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -5,6 +5,7 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  {{- metatags }}
   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
   {%- block extrahead %} {% endblock %}
   <link rel="stylesheet" href="{{ pathto('_static/icons.css', 1)|e }}" type="text/css" />

diff --git a/docs/conf.py b/docs/conf.py
@@ -47,6 +47,7 @@
     "sphinxcontrib.towncrier.ext",
     "hoverxref.extension",
     "notfound.extension",
+    "sphinxext.opengraph",
     "redirects",
     "fulltoc",
     "exception_hierarchy",
@@ -276,6 +277,16 @@ def linkcode_resolve(domain: str, info: Dict[str, Any]) -> Optional[str]:
     html_use_opensearch = html_baseurl.rstrip("/")
 
 
+# ogp_site_url = ""  # automatically set on readthedocs
+ogp_site_name = "disnake documentation"
+ogp_image = "https://disnake.dev/assets/disnake-logo-transparent.png"
+ogp_image_alt = "disnake icon"
+ogp_custom_meta_tags = [
+    '<meta property="og:image:width" content="64" />',
+    '<meta property="og:image:height" content="64" />',
+]
+
+
 # -- Options for HTML output ----------------------------------------------
 
 html_experimental_html5_writer = True

diff --git a/docs/extensions/builder.py b/docs/extensions/builder.py
@@ -5,11 +5,12 @@
 import inspect
 from typing import TYPE_CHECKING, Any
 
+from docutils import nodes
 from sphinx.environment.adapters.indexentries import IndexEntries
+from sphinxext.opengraph.descriptionparser import DescriptionParser
 
 if TYPE_CHECKING:
     from _types import SphinxExtensionMeta
-    from docutils import nodes
     from sphinx.application import Sphinx
     from sphinx.config import Config
     from sphinx.writers.html5 import HTML5Translator
@@ -57,6 +58,22 @@ def patch_genindex(*args: Any) -> None:
     IndexEntries.create_index = new_create_index  # type: ignore
 
 
+def patch_opengraph(*args: Any) -> None:
+    # Patch sphinxext-opengraph's description parser to only take the first section
+    # into account, resulting in cleaner descriptions.
+    orig = DescriptionParser.dispatch_visit
+
+    def patched_dispatch_visit(self, node: nodes.Element) -> None:
+        if isinstance(node, nodes.section):
+            if getattr(self, "section_found", False):
+                # stop when encountering nested section
+                raise nodes.StopTraversal
+            self.section_found = True
+        return orig(self, node)
+
+    DescriptionParser.dispatch_visit = patched_dispatch_visit
+
+
 def disable_mathjax(app: Sphinx, config: Config) -> None:
     # prevent installation of mathjax script, which gets installed due to
     # https://github.com/readthedocs/sphinx-hoverxref/commit/7c4655092c482bd414b1816bdb4f393da117062a
@@ -71,6 +88,7 @@ def disable_mathjax(app: Sphinx, config: Config) -> None:
 
 def setup(app: Sphinx) -> SphinxExtensionMeta:
     app.connect("config-inited", patch_genindex)
+    app.connect("config-inited", patch_opengraph)
     app.connect("config-inited", disable_mathjax)
     app.connect("builder-inited", set_translator)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -59,6 +59,7 @@ docs = [
     "sphinxcontrib-towncrier==0.3.2a0",
     "towncrier==23.6.0",
     "sphinx-notfound-page==0.8.3",
+    "sphinxext-opengraph==0.7.5"
 ]
 discord = ["discord-disnake"]