This repository has been archived by the owner on Jan 29, 2024. It is now read-only.
Overwrite canonical without html with sphinx extension #1905
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.
What changed, and why it matters
To resolve issue #1691 , canonical url updated to
/index.html
->/
and the rest of the pages without
.html
Solution
Create a custom Sphinx extension that adds a HTML context event to override the
pageurl
variable, which is used by Furo to generate the canonical URL.Demo
https://overwrite-canonical-without.devportal.pages.dev/
<link rel="canonical" href="https://docs.aiven.io/">
https://overwrite-canonical-without.devportal.pages.dev/docs/platform
<link rel="canonical" href="https://docs.aiven.io/docs/platform">