-
Notifications
You must be signed in to change notification settings - Fork 361
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Sphinx theme #1946
Update Sphinx theme #1946
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
docs/conf.py
Outdated
|
||
html_logo = 'images/logo.png' | ||
#html_logo = 'images/logo.png' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be deleted. It's better to not have commented out code: https://bytedev.medium.com/code-comment-anti-patterns-and-why-the-comment-you-just-wrote-is-probably-not-needed-919a92cf6758#:~:text=Avoid%20commenting%20out%20code%20and,to%20another%20team%20member%27s%20work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay! Thank you Eric!
docs/conf.py
Outdated
|
||
html_logo = 'images/logo.png' | ||
#html_logo = 'images/logo.png' | ||
#html_sidebars = {'**': ['globaltoc.html']} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can also be deleted
…te-sphinx-theme
…iskit-aer into update-sphinx-theme
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks fine to me is there a reason it's still in draft?
Yes, the reason is the increasing on the time building the documentation, and the size of the files compared with the old theme. I will fix it soon in another PR, but in the meantime, I let it as a draft. I should have updated the comment in this PRs before with the information, but here you can see the details:
|
Thanks @doichanj! Arnau doesn't have write access so will need a maintainer to merge. |
* Update Sphinx theme * importlib-metadata constraint removed * Update conf.py --------- Co-authored-by: Jun Doi <doichan@jp.ibm.com>
Summary
Updates to new Ecosystem theme.
Total file size increased (31.8 MB -> 151 MB)
index.html size increased (9 KB → 149 KB)
Build time increased (343s → 621s)
For more information: Qiskit/qiskit_sphinx_theme#232