Upgrade docs to qiskit_sphinx_theme 1.11 #70
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
Eric-Arellano
commented
May 15, 2023
|
|
||
| html_theme_path = ['.', qiskit_sphinx_theme.get_html_theme_path()] |
There was a problem hiding this comment.
Unnecessary, and qiskit_sphinx_theme.get_html_theme_path() is now deprecated.
| pylint==2.7.1 | ||
| reno>=3.2.0 | ||
| qiskit-sphinx-theme>=1.6, <=1.10.3 | ||
| qiskit-sphinx-theme~=1.11.1 |
There was a problem hiding this comment.
This pins to 1.11 so that your docs don't break overnight on you. We are trying to keep the theme stable, but it is undergoing rapid improvements currently, so it's safer to pin.
I will open PRs to update to future releases.
Comment on lines
-30
to
-32
|
|
||
| [pycodestyle] | ||
| max-line-length = 100 |
eggerdj
approved these changes
May 15, 2023
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.
Closes #67. I suspect the failure was coming from overriding HTML templates, which instead should come from qiskit_sphinx_theme.
This also removes three custom CSS files that are not relevant to qiskit_sphinx_theme.
Finally, it activates jQuery because Sphinx 6 no longer activates it by default and it is needed for qiskit_sphinx_theme.