🔧 Add sphinx sitemap

Author: veit

docs/conf.py

@@ -22,7 +22,12 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx_design", "sphinxext.opengraph", "sphinx_copybutton"]
+extensions = [
+    "sphinx_design",
+    "sphinxext.opengraph",
+    "sphinx_copybutton",
+    "sphinx_sitemap",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = ["README.rst", "lib/*"]
@@ -39,3 +44,19 @@
 html_static_path = ["_static"]
 html_logo = "_static/images/logo/logo.png"
 html_favicon = "_static/images/logo/favicon.ico"
+
+# -- Linkcheck configuration -------------------------------------------------
+
+linkcheck_ignore = [
+    r"http://shop.oreilly.com/*",
+]
+
+# -- sitemap configuration ---------------------------------------------------
+
+sitemap_url_scheme = "{link}"
+sitemap_excludes = [
+    "404.html",
+    "search.html",
+    "genindex.html",
+]
+sitemap_show_lastmod = True

pyproject.toml

@@ -20,6 +20,7 @@ docs = [
     "furo",
     "sphinxext-opengraph",
     "sphinx-copybutton",
+    "sphinx-sitemap",
 ]
 
 dev = [