OpenGraph support on RTD (#327)

innobi · Aug 23, 2024 · 9cb922c · 9cb922c
1 parent 1d7748a
commit 9cb922c
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 18 deletions.
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,2 +1,3 @@
 sphinx
 sphinx_rtd_theme
+sphinxext-opengraph
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -12,6 +12,7 @@
 
 extensions = [
     "sphinx_rtd_theme",
+    "sphinxext.opengraph",
 ]
 
 templates_path = ["_templates"]
@@ -21,10 +22,14 @@
 # -- Options for HTML output -------------------------------------------------
 
 html_theme = "sphinx_rtd_theme"
-html_logo = "../../misc/pantab_logo.svg"
+html_logo = "../../misc/pantab_logo.png"
 master_doc = "index"  # see RTD GH issue 2569
 html_context = {
     "display_github": True,
 }
 
 html_static_path = ["_static"]
+
+# -- Options for opengraph output --------------------------------------------
+
+ogp_site_url = "https://pantab.readthedocs.io/"
diff --git a/environment.yml b/environment.yml
@@ -19,5 +19,6 @@ dependencies:
   - sphinx
   - pre-commit
   - sphinx_rtd_theme
+  - sphinxext-opengraph
   - pip:
     - asv
diff --git a/misc/pantab_logo.png b/misc/pantab_logo.png
diff --git a/misc/pantab_logo.svg b/misc/pantab_logo.svg