fix dirhtml canonical url #53
Merged
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
deprecate canonical_url config in favor of built-in html_baseurl
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Sphinx 1.8 added support for outputting canonical URLs based on the
html_baseurlconfig. However, the dirhtml builder doesn't override the value, so it uses the standard html url that ends with.html. See sphinx-doc/sphinx#9730.Since Sphinx supports generating canonical URLs deprecate our
canonical_urlconfig and remove the related template code.Detect if the dirhtml builder is used and is generating invalid URLs, and use our existing logic to generate the correct URL. The workaround will be skipped if it looks like Sphinx has fixed the bug.
closes #47