Skip to content

Commit a82e7c6

Browse files
Merge pull request saltstack#2 from lumenCodes/user-guide-sitemap
Adding the Sphinx sitemap
2 parents b62fb79 + 20e6252 commit a82e7c6

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/conf.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,11 @@ def setup(app):
109109
"sphinx.ext.todo",
110110
"sphinx-prompt", # Required by sphinx_substitution_extensions
111111
"sphinx_inline_tabs",
112-
"sphinx_substitution_extensions"
112+
"sphinx_substitution_extensions",
113+
'sphinx_sitemap', # Required for the sitemap
113114
]
114115

116+
115117
source_suffix = ".rst"
116118

117119
# Add any paths that contain templates here, relative to this directory.
@@ -138,6 +140,7 @@ def setup(app):
138140
html_show_sourcelink = True # False on private repos; True on public repos
139141
html_theme = 'furo'
140142
html_title = project
143+
html_baseurl = 'https://docs.saltproject.io/salt/user-guide/en/latest/'
141144

142145
html_theme_options = {
143146
"dark_css_variables": {

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ sphinx-copybutton>=0.5.1
44
sphinx-design>=0.3.0
55
sphinx-inline-tabs>=2022.1.2b11
66
sphinx-prompt
7+
sphinx-sitemap==2.6.0
78
sphinx-tabs>=3.4.1
89
sphinx>=5.3.0

0 commit comments

Comments
 (0)