Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

add basic opengraph metadata to documentation (#684)

Benjamin Hackl2839b3f2ce36
diff --git a/docs/requirements.txt b/docs/requirements.txt
index cdcccbc2a..64e2524c0 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,5 @@
Sphinx==3.1.2
guzzle-sphinx-theme
recommonmark>=0.5.0
-sphinx-copybutton
\ No newline at end of file
+sphinx-copybutton
+sphinxext-opengraph
diff --git a/docs/source/conf.py b/docs/source/conf.py
index f9d634ba5..ae80574f7 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -56,6 +56,7 @@ extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autosummary",
"sphinx.ext.doctest",
+ "sphinxext.opengraph",
"manim_directive",
]
@@ -101,3 +102,8 @@ html_static_path = ["_static"]
# This specifies any additional css files that will override the theme's
html_css_files = ["custom.css"]
+
+# opengraph settings
+ogp_image = "https://www.manim.community/logo.png"
+ogp_site_name = "Manim Community | Documentation"
+ogp_site_url = "https://docs.manim.community/"