fix: sitemap config #477
Merged
fix: sitemap config #477
Conversation
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
PR canonical#462 introduced fetching the canonical URL from a RTD environment variable. In versioned docs, this URL includes the version, which means that the previous logic to set the sitemap_url_scheme is no longer necessary and duplicates the version (e.g., "../latest/latest/.."). This fix removes the duplication. Since the html_baseurl value falls back to "/", there is also no need to set a separate sitemap_url_scheme for local builds. Signed-off-by: Minae Lee <[email protected]>
minaelee
force-pushed
the
sitemap-config
branch
from
bd9892e to
bf69420
Compare
minaelee
force-pushed
the
sitemap-config
branch
from
bf69420 to
0939fac
Compare
minaelee
requested review from
SecondSkoll,
akcano,
dwilding,
medubelko,
rkratky and
tang-mm
as code owners
akcano
reviewed
Dec 5, 2025
minaelee
force-pushed
the
sitemap-config
branch
3 times, most recently
from
a89a667 to
66bd693
Compare
This updates the sitemaps how-to guide to reflect changes to how the html_baseurl is generated and how sitemap_url_scheme is set. It also updates the changelog to reflect removal of the duplicate version strings in sitemaps. Signed-off-by: Minae Lee <[email protected]>
minaelee
force-pushed
the
sitemap-config
branch
from
66bd693 to
15b0b3d
Compare
akcano
approved these changes
Dec 9, 2025
SecondSkoll
added a commit
that referenced
this pull request
Dec 10, 2025
* fix: doc slugs and additional initialised Makefile variables (#468) - Switch doc links to `stable` slug. - In Makefile, don't init `SOURCEDIR` and `VENVDIR` variables if they already exist at run time. This lets projects override these dirs in parent build scripts. * ci: make workflows callable by other workflows * chore: add entries from #468 to changelog * docs: remove contributing guide template from index (#471) * fix(build): replace U+2011 chars with hyphens (#472) * docs: list 'cla-check.yaml' as optional in tutorial (#469) * fix: sitemap config (#477) * fix: remove redundancy in sitemap_url_scheme PR #462 introduced fetching the canonical URL from a RTD environment variable. In versioned docs, this URL includes the version, which means that the previous logic to set the sitemap_url_scheme is no longer necessary and duplicates the version (e.g., "../latest/latest/.."). This fix removes the duplication. Since the html_baseurl value falls back to "/", there is also no need to set a separate sitemap_url_scheme for local builds. * doc: update sitemaps how-to guide and changelog Updates sitemaps how-to guide to reflect changes to how html_baseurl is generated and sitemap_url_scheme is set. Updates changelog to reflect removal of duplicate version strings in sitemaps. Signed-off-by: Minae Lee <[email protected]> * chore: 1.3.1 release prep --------- Signed-off-by: Minae Lee <[email protected]> Co-authored-by: Artem Konev <[email protected]> Co-authored-by: Arturo Seijas <[email protected]> Co-authored-by: Michael DuBelko <[email protected]> Co-authored-by: JJ Coldiron <[email protected]> Co-authored-by: Minae Lee <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
CHANGELOG.mdwith relevant non-documentation file changes?PR #462 introduced fetching the canonical URL from a RTD environment variable. In versioned docs, this URL includes the version, which means that the previous logic to set the
sitemap_url_schemeis no longer necessary and duplicates the version, as in these examples:This fix removes the duplication and should work for both versioned and non-versioned docs. Since the
html_baseurlvalue falls back to"/", there is also no need to set a separatesitemap_url_schemefor local builds.