Skip to content

Docs: Add sitemap support using sphinx_sitemap #4161

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 2 commits into from
Jun 26, 2025
Merged

Docs: Add sitemap support using sphinx_sitemap #4161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1000be
sitemap config
geoffreynyaga Jun 16, 2025
439ca87
fix language and version
geoffreynyaga Jun 19, 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
1 change: 1 addition & 0 deletions docs/.sphinx/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ canonical-sphinx[full] @ git+https://github.com/canonical/canonical-sphinx@main
sphinx-autobuild
sphinxcontrib-svg2pdfconverter[CairoSVG]
sphinx-last-updated-by-git
sphinx-sitemap
13 changes: 8 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
project = "Multipass"
author = "Canonical Ltd."

#root_doc = "src/index"
# root_doc = "src/index"

# Sidebar documentation title; best kept reasonably short
#
Expand Down Expand Up @@ -72,6 +72,8 @@

ogp_site_url = "https://documentation.ubuntu.com/multipass"

html_baseurl = "https://documentation.ubuntu.com/multipass/" # for sitemap.xml, the trailing slash is important
sitemap_url_scheme = "en/latest/{link}"

# Preview name of the documentation website
#
Expand Down Expand Up @@ -162,7 +164,7 @@
# TODO: If your documentation is hosted on https://docs.ubuntu.com/,
# uncomment and update as needed.

slug = 'multipass'
slug = "multipass"


# Template and asset locations
Expand Down Expand Up @@ -196,7 +198,7 @@
# TODO: Remove or adjust the ACME entry after you update the contributing guide

linkcheck_ignore = [
"https://app.element.io/#/room/#Multipass:matrix.org",
"https://app.element.io/#/room/#Multipass:matrix.org",
"http://127.0.0.1:8000",
"http://127.0.0.1:8001",
"https://localhost:8080",
Expand All @@ -205,8 +207,8 @@
"https://sourceforge.net/projects/vcxsrv/",
"https://sourceforge.net/projects/xming/",
"http://www.straightrunning.com/XmingNotes/",
"https://unix.stackexchange.com", # it seems stackexchange is now blocking bots
]
"https://unix.stackexchange.com", # it seems stackexchange is now blocking bots
]

linkcheck_retries = 3

Expand Down Expand Up @@ -250,6 +252,7 @@
"canonical_sphinx",
"sphinxcontrib.cairosvgconverter",
"sphinx_last_updated_by_git",
"sphinx_sitemap",
]

# Excludes files or directories from processing
Expand Down
Loading