fix(docs): use environment variable instead of config context for html_baseurl
#1049
Conversation
This file contains 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
shiftinv
added
t: documentation
shiftinv
added
needs backport: 2.8
and removed
needs backport: 2.8
s: needs review
shiftinv
added a commit
that referenced
this pull request
Jun 21, 2023
…ml_baseurl` (#1049) Fixes readthedocs builds, which broke some time within the last 24 hours due to an upstream change which resulted in the `html_baseurl` variable being set to `""`. This has the (positive) side-effect of `<link rel="canonical" />` no longer always pointing to `stable`, and instead using the version that's being built. The same applies to the opensearch config.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes readthedocs builds (#1048 (comment)), which broke some time within the last 24 hours due to an upstream change which resulted in the
html_baseurlvariable being set to"". Not quite sure what caused it, but as far as I can tell this PR is how you're supposed to do it nowadays (readthedocs/readthedocs.org#10224).This has the (positive) side-effect of
<link rel="canonical" />no longer always pointing tostable, and instead using the version that's being built. The same applies to the opensearch config.Checklist
pdm lintpdm pyright