Skip to content

Adding the Sphinx sitemap #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 3, 2025
Merged

Adding the Sphinx sitemap #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58f2f81
adding the sitemap
lumenCodes May 1, 2025
8b19dbc
updated the requirements.txt file to include the sitemap extension
lumenCodes May 1, 2025
20e6252
updating the conf.py with the sitemap extension
lumenCodes May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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": {
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +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