From 58f2f81d74b5d94a88ddd26d5ae12ecc952ca5d1 Mon Sep 17 00:00:00 2001 From: Chinwendu Date: Thu, 1 May 2025 08:52:17 +0100 Subject: [PATCH 1/3] adding the sitemap --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2d81999..c111ffb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -109,9 +109,11 @@ def setup(app): "sphinx.ext.todo", "sphinx-prompt", # Required by sphinx_substitution_extensions "sphinx_inline_tabs", - "sphinx_substitution_extensions" + "sphinx_substitution_extensions", + "sphinx-sitemap", # Required for the sitemap ] + source_suffix = ".rst" # Add any paths that contain templates here, relative to this directory. @@ -138,6 +140,7 @@ def setup(app): html_show_sourcelink = True # False on private repos; True on public repos html_theme = 'furo' html_title = project +html_baseurl = 'https://docs.saltproject.io/salt/user-guide/en/latest/' html_theme_options = { "dark_css_variables": { From 8b19dbc62fa5dca6e3eb0b956fcf9be861d9badb Mon Sep 17 00:00:00 2001 From: Chinwendu Date: Thu, 1 May 2025 17:33:35 +0100 Subject: [PATCH 2/3] updated the requirements.txt file to include the sitemap extension --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index ec9a5dc..6d45494 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -6,3 +6,4 @@ sphinx-inline-tabs>=2022.1.2b11 sphinx-prompt sphinx-tabs>=3.4.1 sphinx>=5.3.0 +sphinx-sitemap \ No newline at end of file From 20e62528266d8c0c0a6896d64c03c0a039b86b31 Mon Sep 17 00:00:00 2001 From: Chinwendu Date: Fri, 2 May 2025 22:20:36 +0100 Subject: [PATCH 3/3] updating the conf.py with the sitemap extension --- docs/conf.py | 2 +- docs/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c111ffb..39bf47c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -110,7 +110,7 @@ def setup(app): "sphinx-prompt", # Required by sphinx_substitution_extensions "sphinx_inline_tabs", "sphinx_substitution_extensions", - "sphinx-sitemap", # Required for the sitemap + 'sphinx_sitemap', # Required for the sitemap ] diff --git a/docs/requirements.txt b/docs/requirements.txt index 6d45494..e3f3a08 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,6 +4,6 @@ sphinx-copybutton>=0.5.1 sphinx-design>=0.3.0 sphinx-inline-tabs>=2022.1.2b11 sphinx-prompt +sphinx-sitemap==2.6.0 sphinx-tabs>=3.4.1 sphinx>=5.3.0 -sphinx-sitemap \ No newline at end of file