patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: generate sitemap.xml

Browse source 
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é <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-02-26 11:59:57 +01:00 committed by Johan Hedberg
parent d8b368a160
commit 8f17c830ed
2 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/conf.py
View file

@ -86,6 +86,7 @@ extensions = [
"zephyr.dtcompatible-role", "zephyr.dtcompatible-role",
"zephyr.link-roles", "zephyr.link-roles",
"sphinx_tabs.tabs", "sphinx_tabs.tabs",
"sphinx_sitemap",
"zephyr.warnings_filter", "zephyr.warnings_filter",
"zephyr.doxyrunner", "zephyr.doxyrunner",
"zephyr.gh_utils", "zephyr.gh_utils",
@ -351,6 +352,10 @@ graphviz_dot_args = [
copybutton_prompt_text = r"\$ |uart:~\$ " copybutton_prompt_text = r"\$ |uart:~\$ "
copybutton_prompt_is_regexp = True copybutton_prompt_is_regexp = True
# -- Options for sphinx-sitemap ----------------------------------------
sitemap_url_scheme = "{link}"
# -- Linkcheck options ---------------------------------------------------- # -- Linkcheck options ----------------------------------------------------
linkcheck_ignore = [ linkcheck_ignore = [

1
doc/requirements.txt
View file

@ -9,6 +9,7 @@ pygments>=2.9
sphinx-notfound-page sphinx-notfound-page
sphinx-copybutton sphinx-copybutton
sphinx-togglebutton sphinx-togglebutton
sphinx-sitemap
# YAML validation. Used by zephyr_module. # YAML validation. Used by zephyr_module.
PyYAML>=6.0 PyYAML>=6.0