doc: generate sitemap.xml

Generate a sitemap.xml for the documentation. This aims at helping search engines react faster to the addition/removal of new pages. Signed-off-by: Benjamin Cabé <[email protected]>
zephyrproject-rtos · Apr 3, 2024 · 8f17c83 · 8f17c83
1 parent d8b368a
commit 8f17c83
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -86,6 +86,7 @@
     "zephyr.dtcompatible-role",
     "zephyr.link-roles",
     "sphinx_tabs.tabs",
+    "sphinx_sitemap",
     "zephyr.warnings_filter",
     "zephyr.doxyrunner",
     "zephyr.gh_utils",
@@ -351,6 +352,10 @@
 copybutton_prompt_text = r"\$ |uart:~\$ "
 copybutton_prompt_is_regexp = True
 
+# -- Options for sphinx-sitemap ----------------------------------------
+
+sitemap_url_scheme = "{link}"
+
 # -- Linkcheck options ----------------------------------------------------
 
 linkcheck_ignore = [

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -9,6 +9,7 @@ pygments>=2.9
 sphinx-notfound-page
 sphinx-copybutton
 sphinx-togglebutton
+sphinx-sitemap
 
 # YAML validation. Used by zephyr_module.
 PyYAML>=6.0