Use sphinxext-opengraph

pyauth · May 7, 2023 · 55f69ba · 55f69ba
1 parent 04af2b6
commit 55f69ba
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/Makefile b/Makefile
@@ -14,7 +14,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: clean

diff --git a/docs/conf.py b/docs/conf.py
@@ -10,14 +10,15 @@
 release = ""
 language = "en"
 master_doc = "index"
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.intersphinx"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.intersphinx", "sphinxext.opengraph"]
 source_suffix = [".rst", ".md"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 pygments_style = "sphinx"
 intersphinx_mapping = {
     "https://docs.python.org/3": None,
 }
 templates_path = [""]
+ogp_site_url = "https://pyauth.github.io/pyotp/"
 
 if "readthedocs.org" in os.getcwd().split("/"):
     with open("index.rst", "w") as fh: