Fix HTML meta-tag output #197
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
Commit 6538ba1 (Qiskitgh-119) removed several bits of HTML meta information from the Jinja template of the layout. This caused (amongst other things): * the HTML "title" elements to not be output, which means that things like search engines couldn't display nice output and tab titles were missing information * the `<meta charset="utf-8">` (or appropriate charset) to be omitted. Some OSes and browser combinations would then default to `latin-1` (or other) and not utf-8 for some pages, making several text-output circuit drawings illegible. This commit restores the meta-tag information to the relevant Jinja template, and tidies up some duplicate outputs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Commit 6538ba1 (gh-119) removed several bits of HTML meta information from the Jinja template of the layout. This caused (amongst other things):
the HTML "title" elements to not be output, which means that things like search engines couldn't display nice output and tab titles were missing information
the
<meta charset="utf-8">(or appropriate charset) to be omitted. Some OSes and browser combinations would then default tolatin-1(or other) and not utf-8 for some pages, making several text-output circuit drawings illegible.This commit restores the meta-tag information to the relevant Jinja template, and tidies up some duplicate outputs.
As a side note: there doesn't appear to be a favicon defined anywhere, though Sphinx officially supports one. I suspect that this happens to work for our deployed documentation because there's one at https://qiskit.org/favicon.ico and historically web browsers have always just sent an exploratory request there to see. The favicon being absent is why local builds don't get one, though.