docs: move docs to ubuntu.com/docs/pebble#882
Open
dwilding wants to merge 5 commits into
Open
Conversation
dwilding
commented
Jun 4, 2026
|
|
||
| # sphinx-sitemap uses html_baseurl to generate the full URL for each page: | ||
| sitemap_url_scheme = "{link}" | ||
| sitemap_filename = "doc-sitemap.xml" |
Contributor
Author
There was a problem hiding this comment.
We need to customise the sitemap filename to prevent Read the Docs from deleting it (🤷♂️). I'll be updating the central ubuntu.com config to locate our sitemap.
dwilding
force-pushed
the
dotcom-migration
branch
from
0b63761 to
6f0ea57
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates our doc config so that all URLs use
ubuntu.com/docs/pebbleinstead of the backend URL from Read the Docs. Our docs are still hosted on Read the Docs, but we'll be proxying them under ubuntu.com/docs.Preview docs built from this branch. After this PR merges, I'll switch those docs to build from
masterand redirect the existing docs.Main changes
docs/conf.py.docs/_static/overwrite_links.js, which is not strictly needed at the moment. This script makes sure that the version switcher from Read the Docs has correct URLs - but we don't use the version switcher. I'm including the script because it's a standard part of the new docs setup at Canonical.Extra changes
Future work (not in this PR)