From 3826cfae981ea936242aaeb21629419bdf281745 Mon Sep 17 00:00:00 2001 From: Lumencodes Date: Wed, 7 May 2025 20:43:55 +0100 Subject: [PATCH 1/4] adding the sitemap extension --- docs/conf.py | 2 ++ docs/requirements.txt | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index c9fdf33..af797c9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,6 +111,7 @@ def setup(app): "sphinx-prompt", # Required by sphinx_substitution_extensions "sphinx_inline_tabs", "sphinx_substitution_extensions", + "sphinx-sitemap", ] # Render TODO directives todo_include_todos = True @@ -143,6 +144,7 @@ def setup(app): html_show_sourcelink = True # False on private repos; True on public repos html_theme = "furo" html_title = "Salt install guide" +html_baseurl = "https://docs.saltproject.io/salt/install-guide/en/latest/" html_theme_options = { "dark_css_variables": { diff --git a/docs/requirements.txt b/docs/requirements.txt index f91cb4a..95b70d1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -6,3 +6,5 @@ sphinx-prompt>=1.5.0 sphinx-substitution-extensions>=2022.02.16 sphinx-tabs>=3.4.7 sphinx>=5.3.0 +sphinx-sitemap==2.6.0 + From db9057f1910a706c84ff40bddffc043fbe5787a9 Mon Sep 17 00:00:00 2001 From: Lumencodes Date: Sat, 10 May 2025 23:10:22 +0100 Subject: [PATCH 2/4] referenced Sitemap in conf.py --- docs/requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 95b70d1..8f2a9ec 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,8 +3,7 @@ sphinx-copybutton>=0.5.2 sphinx-design>=0.5.0 sphinx-inline-tabs>=2023.4.21 sphinx-prompt>=1.5.0 +sphinx-sitemap==2.6.0 sphinx-substitution-extensions>=2022.02.16 sphinx-tabs>=3.4.7 sphinx>=5.3.0 -sphinx-sitemap==2.6.0 - From 0f3e3dbc425449378b2e6ab34b49bee744c29cdf Mon Sep 17 00:00:00 2001 From: Lumencodes Date: Sat, 10 May 2025 23:14:51 +0100 Subject: [PATCH 3/4] referenced Sitemap in conf.py --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index af797c9..07a7191 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,7 +111,7 @@ def setup(app): "sphinx-prompt", # Required by sphinx_substitution_extensions "sphinx_inline_tabs", "sphinx_substitution_extensions", - "sphinx-sitemap", + "sphinx_sitemap", ] # Render TODO directives todo_include_todos = True From bf624cb797a68c6dea7c89ef05a877ee7c96465d Mon Sep 17 00:00:00 2001 From: Lumencodes Date: Wed, 14 May 2025 14:43:38 +0100 Subject: [PATCH 4/4] updated the base URL --- docs/conf.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 07a7191..3c02e9b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -144,7 +144,15 @@ def setup(app): html_show_sourcelink = True # False on private repos; True on public repos html_theme = "furo" html_title = "Salt install guide" -html_baseurl = "https://docs.saltproject.io/salt/install-guide/en/latest/" +html_baseurl = "https://docs.saltproject.io/salt/install-guide/" + +# Extends baseurl, in combination with version value +sitemap_locales = ["en"] +# Pages we don't care to include in generated sitemap file +sitemap_excludes = [ + "search.html", + "genindex.html", +] html_theme_options = { "dark_css_variables": {