Deprecate canonical_url in favor of html_baseurl#178
Merged
AA-Turner merged 2 commits intosphinx-doc:masterfrom Jan 8, 2024
Merged
Deprecate canonical_url in favor of html_baseurl#178AA-Turner merged 2 commits intosphinx-doc:masterfrom
AA-Turner merged 2 commits intosphinx-doc:masterfrom
Conversation
Rely on html_baseurl for the canonical url instead. The canonical url is already set in the basic theme https://github.com/sphinx-doc/sphinx/blob/4e9d1553968653df6699b20afc22b73eb3280185/sphinx/themes/basic/layout.html#L130-L132 That takes into account pages using the dirhtml builder instead of always adding the `html` extension. This was introduced in sphinx 1.8.
6 tasks
# Conflicts: # alabaster/layout.html
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
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.
Rely on html_baseurl for the canonical url instead.
The canonical url is already set in the basic theme
https://github.com/sphinx-doc/sphinx/blob/4e9d1553968653df6699b20afc22b73eb3280185/sphinx/themes/basic/layout.html#L130-L132
That takes into account pages using the dirhtml builder
instead of always adding the
htmlextension.This was introduced in sphinx 1.8.