Skip to content

Adding the Sphinx sitemap extension #32

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,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
Expand Down Expand Up @@ -149,6 +150,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/"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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": {
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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