Use sphinxext-opengraph

XML-Security · May 7, 2023 · 5e0cc15 · 5e0cc15
1 parent 9515310
commit 5e0cc15
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ init_docs:
 	cd docs; sphinx-quickstart
 
 docs:
-	python -m pip install furo sphinx-copybutton
+	python -m pip install furo sphinx-copybutton sphinxext-opengraph
 	sphinx-build docs docs/html
 
 install:

diff --git a/docs/conf.py b/docs/conf.py
@@ -7,7 +7,13 @@
 release = ""
 language = "en"
 master_doc = "index"
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.intersphinx", "sphinx_copybutton"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "sphinxext.opengraph",
+]
 source_suffix = [".rst", ".md"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 pygments_style = "sphinx"
@@ -21,6 +27,7 @@
     "https://www.pyopenssl.org/en/stable": "https://www.pyopenssl.org/en/stable/objects.inv",
 }
 templates_path = [""]
+ogp_site_url = "https://xml-security.github.io/" + project
 
 if "readthedocs.org" in os.getcwd().split("/"):
     with open("index.rst", "w") as fh: