docs: add opengraph metadata to HTML website

better referencing in search engines, and nicer "social media" sharing previews
epics-extensions · Dec 13, 2024 · 305a499 · 305a499
1 parent 7c3a41a
commit 305a499
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,6 +30,7 @@
     "sphinx.ext.githubpages",
     "sphinx_copybutton",
     "sphinxcontrib_nixdomain",
+    "sphinxext.opengraph",
 ]
 
 templates_path = ["_templates"]
@@ -126,3 +127,10 @@ def nix_linkcode_resolve(path: str) -> str:
 ]
 
 man_show_urls = True
+
+# -- Options for OpenGraph ---------------------------------------------------
+# https://sphinxext-opengraph.readthedocs.io/en/latest/
+
+ogp_site_url = html_baseurl
+ogp_image = "_static/logo.svg"
+ogp_image_alt = "EPNix logo"
diff --git a/pkgs/docs/default.nix b/pkgs/docs/default.nix
@@ -103,6 +103,7 @@ in
         sphinx
         sphinx-copybutton
         sphinxcontrib-nixdomain
+        sphinxext-opengraph
       ])
       ++ [
         installShellFiles