Merged
Conversation
eric-wieser
approved these changes
Sep 1, 2020
Member
There was a problem hiding this comment.
Looks good to me, this appears to match what sphinx themselves did https://github.com/sphinx-doc/sphinx/pull/4764/files.
Let's check the doc build when CI finishes to see that the links are valid, but otherwise should be good to merge.
Member
Member
|
Thanks @susan-shu-c |
Contributor
Author
|
Awesome, thanks @eric-wieser and @mattip for looking over this. The docs to get started and build the docs are very clear! |
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.
Resolves #17069 adding canonical urls to the header of docs.
I have tested it locally which adds the canonical url in the generated .html files.
The indentation I used in
layout.htmlis so that the generated ones line up (see last line of screenshot).A similar way that the folks at Sphinx did it: link to merged PR
I opted not to use the
{% block linktags %}they used due to unexpected behavior (thehrefis generated correctly, but duplicated) when building innumpy.