Documentation: add sitemap (#419)

Guts · Feb 19, 2024 · af3a4f3 · af3a4f3
2 parents b475460 + fb80101
commit af3a4f3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,6 +51,7 @@
     "sphinx_design",
     "sphinxcontrib.mermaid",
     "sphinxext.opengraph",
+    "sphinx_sitemap",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -96,6 +97,11 @@
 
 # -- Options for HTML output -------------------------------------------------
 
+suppress_warnings = ["myst.duplicate_def"]
+
+# final URL
+html_baseurl = __about__.__uri_homepage__
+
 # Theme
 html_favicon = "static/logo_qdt.png"
 html_logo = "static/logo_qdt.png"
@@ -191,6 +197,9 @@
     f'<meta property="twitter:title" content="{project}" />',
 ]
 
+# sitemap
+sitemap_url_scheme = "{link}"
+
 # -- Functions ------------------------------------------------------------------
 
 

diff --git a/requirements/documentation.txt b/requirements/documentation.txt
@@ -10,6 +10,7 @@ sphinx-copybutton<1
 sphinx-design>=0.5,<1
 sphinxcontrib-mermaid>=0.9,<1
 sphinxext-opengraph>=0.4,<1
+sphinx-sitemap>=2.4,<3
 
 # -- 'HIDDEN' dependencies, used during CI
 # pip-licenses<5