Add opengraph support for NeMo docs (NVIDIA#6380)

* Add opengraph support for NeMo docs Signed-off-by: smajumdar <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add opengraph support for NeMo docs Signed-off-by: smajumdar <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Signed-off-by: smajumdar <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: hsiehjackson <[email protected]>
hsiehjackson · Jun 2, 2023 · 2873f10 · 2873f10
1 parent 1a5a769
commit 2873f10
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -112,6 +112,7 @@
     "sphinx.ext.autosectionlabel",
     "sphinxcontrib.bibtex",
     "sphinx_copybutton",
+    "sphinxext.opengraph",
 ]
 
 bibtex_bibfiles = [
@@ -254,3 +255,10 @@ def setup(app):
 # html_js_files = [
 #     './pk_scripts.js',
 # ]
+
+# OpenGraph settings
+ogp_site_url = 'https://nvidia.github.io/NeMo/'
+ogp_image = 'https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/main/_static/nv_logo.png'
+
+# MathJax CDN
+mathjax_path = "https://cdn.jsdelivr.net/npm/[email protected]/es5/mml-chtml.min.js"
diff --git a/requirements/requirements_docs.txt b/requirements/requirements_docs.txt
@@ -8,4 +8,5 @@ Sphinx>=4.0,<6,!=5.0.0
 sphinx-book-theme
 sphinx-copybutton
 sphinxcontrib-bibtex
+sphinxext-opengraph
 wrapt