From 4bce90152abae197b61ba0120018394fe64a9e5c Mon Sep 17 00:00:00 2001 From: "Julien M." Date: Mon, 19 Feb 2024 13:43:22 +0100 Subject: [PATCH] docs: add sitemap --- docs/conf.py | 9 +++++++++ requirements/documentation.txt | 1 + 2 files changed, 10 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index d498e4a5..0f0690e6 100644 --- 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'', ] +# sitemap +sitemap_url_scheme = "{link}" + # -- Functions ------------------------------------------------------------------ diff --git a/requirements/documentation.txt b/requirements/documentation.txt index 9c98a9f5..879f553e 100644 --- a/requirements/documentation.txt +++ b/requirements/documentation.txt @@ -9,6 +9,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