qiskit-community / qiskit-nature

Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.
https://qiskit-community.github.io/qiskit-nature/
Apache License 2.0
306 stars 207 forks source link

Update Sphinx theme #1262

Closed arnaucasau closed 1 year ago

arnaucasau commented 1 year ago

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: https://github.com/Qiskit/qiskit_sphinx_theme/issues/232

coveralls commented 1 year ago

Pull Request Test Coverage Report for Build 6506259513


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

💛 - Coveralls
mrossinek commented 1 year ago

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 commented 1 year ago

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 https://github.com/Qiskit/qiskit_sphinx_theme/issues/328.

arnaucasau commented 1 year ago

Thanks a lot @mrossinek, typo corrected!

Eric-Arellano commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

Ah okay, 0.7 sounds good. Thanks!