Merge pull request #32 from lumenCodes/adding-sitemap

Adding the Sphinx sitemap extension

Author: lumenCodes

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,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/"
+
+# 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": {

docs/requirements.txt

@@ -3,6 +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