DOC - add proper meta tags in the API pages - #2267
Closed
rcap107 wants to merge 4 commits into
Closed
Conversation
Member
Author
|
closing because the history was messed up |
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
1 participant
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 modifies how API pages are rendered by sphinx so that their HTML includes
metatags that contain the first line of the docstrings as description.This is because search engines rely on meta tags to describe the content of a page as their search summary (see https://developers.google.com/search/docs/appearance/snippet).
Without this PR, the description was
which is not useful at all, and is indeed the same description for all pages.