fix: canonical links #1258
Merged
fix: canonical links #1258
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
When using `dirhtml`, the final `index/` must be stripped from the canonical URL. E.g. `https://example.org/` instead of `https://example.org/index/`.
✅ Deploy Preview for sphinxawesome-theme ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Merged
kai687
added a commit
that referenced
this pull request
Apr 16, 2023
Upstream Sphinx doesn't construct canonical links correctly for the DirectoryHTMLBuilder. When I introduced #650, it included a bug for `index.html` pages. This PR adds a proper fix with tests this time to make sure that canonical links are what they should be. This PR is a follow up of #1258 and reverts the change in `layout.html`. Checking the canonical link shouldn't be done in the template. It's reported here: [#9730](sphinx-doc/sphinx#9730)
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.
This PR fixes canonical links for "index" pages.
When using the
dirhtmlbuilder, the canonical link should behttps://example.org/instead ofhttps://example.org/index/. I think this is an upstream bug in Sphinx.