Fix canonical URLs with dirhtml builder #870
Closed
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.
As suggested by @ericholscher in #285, using the logic from the
readthedocs-sphinx-ext package.
Currently if you set the
canonical_url
theme option (for example, tohttps://example.com/
), a canonical link like the following will begenerated for source files like
foo/bar.rst
:This is good for the
html
builder, but doesn't match the output of thedirhtml
builder. This commit changes canonical link generation likethe above example to the following when the
dirhtml
builder is used:Canonical link generation remains the same as before when the
dirhtml
builder is not used.