Skip to content
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

Merged
merged 3 commits into from
Oct 13, 2023
Merged

Conversation

arnaucasau
Copy link
Contributor

@arnaucasau arnaucasau commented Sep 29, 2023

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

Co-authored-by: Frank Harkins <[email protected]>
@coveralls
Copy link

coveralls commented Sep 29, 2023

Pull Request Test Coverage Report for Build 6506259513

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.74%

Totals Coverage Status
Change from base Build 6504566380: 0.0%
Covered Lines: 8707
Relevant Lines: 10038

💛 - Coveralls

@mrossinek
Copy link
Member

I do not see too big of an issue with the increase in file size.

Build time increased (93s → 958s)

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 qiskit_nature.second_q.circuit.library classes) which has been a time-consuming process in the past, too.

Here are some potentially relevant PRs from the past:

@Eric-Arellano
Copy link
Contributor

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?

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.

@arnaucasau arnaucasau marked this pull request as ready for review October 13, 2023 09:41
Copy link
Member

@mrossinek mrossinek left a 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 👍

@mrossinek mrossinek merged commit 12f23a7 into qiskit-community:main Oct 13, 2023
13 checks passed
@arnaucasau
Copy link
Contributor Author

Thanks a lot @mrossinek, typo corrected!

@Eric-Arellano
Copy link
Contributor

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).

@mrossinek
Copy link
Member

We can try backporting but I am honestly not sure about the state of the stable branch right now.
0.7 should be going out soon though, so if this is not required to be out before the end of October, waiting for up to 2 weeks is probably easiest for everyone.

@Eric-Arellano
Copy link
Contributor

Ah okay, 0.7 sounds good. Thanks!

ialsina pushed a commit to ialsina/qiskit-nature that referenced this pull request Nov 17, 2023
* Update Sphinx theme

Co-authored-by: Frank Harkins <[email protected]>

* Fix docs heading levels

---------

Co-authored-by: Frank Harkins <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants