-
Notifications
You must be signed in to change notification settings - Fork 207
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 #1262
Update Sphinx theme #1262
Conversation
Co-authored-by: Frank Harkins <[email protected]>
Pull Request Test Coverage Report for Build 6506259513
💛 - Coveralls |
I do not see too big of an issue with the increase in file size.
But this build time increase is pretty rough. I see that the main change under the hood was to switch to a different theme. But have other changes been made to the Sphinx setup? From the top of my head I could see that the use of different class documentation templates with or without inherited members might not work. This will cause many dependencies to be pulled in (e.g. in the Here are some potentially relevant PRs from the past: |
Yeah, we know about it and Arnau will work on improvements. It's due to issues with Furo, the base theme we use. See Qiskit/qiskit_sphinx_theme#328. |
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.
The updated build times after the merge of #1264 looks a lot more reasonable, thanks a lot!
Although I think there is a typo in the file size of the built docs, I am not too worried about that 👍
Thanks a lot @mrossinek, typo corrected! |
Thanks @mrossinek! Should Arnau cherry-pick these changes to stable/0.6? We're hoping to deploy the change soon because it's a priority to kill the old Pytorch theme with the Qiskit top nav bar (branding issue). |
We can try backporting but I am honestly not sure about the state of the stable branch right now. |
Ah okay, 0.7 sounds good. Thanks! |
* Update Sphinx theme Co-authored-by: Frank Harkins <[email protected]> * Fix docs heading levels --------- Co-authored-by: Frank Harkins <[email protected]>
Summary
Updates to new Ecosystem theme.
Total file size increased (5.45 MB → 7.18 MB)
index.html size increased (15 KB → 65 KB)
Build time increased (93s → 109s)
For more information: Qiskit/qiskit_sphinx_theme#232