qiskit-community / qiskit-metal

Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease.
https://qiskit-community.github.io/qiskit-metal/
Apache License 2.0
270 stars 201 forks source link

Upgrade Sphinx Theme to 1.12 and remove template overrides and CSS files #936

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Did you add tests to cover your changes (yes/no)?

n/a.

Did you update the documentation accordingly (yes/no)?

n/a

Did you read the CONTRIBUTING document (yes/no)?

yes

Summary

Upgrades to qiskit-sphinx-theme 1.12. See https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.11.0 and https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.12.0rc1 for the detailed changelogs.

Some highlights:

This makes some other docs improvements:

Finally, this removes some unnecessary CSS files:

zlatko-minev commented 1 year ago

Thanks, @Eric-Arellano, Re "n/a. But note that I couldn't build the docs locally because I have an M1 and pyside2 cannot be built on Apple Silicon." I wonder if we should add a simple workaround in the spot that you see it fail

I think i understand this worked ok for you and the checks have passed, Going to merge in after updating and the update checks complete

Eric-Arellano commented 1 year ago

Thanks, @zlatko-minev! I couldn't get Linux working on my M1, but I realized this morning that you already build the docs in CI and you can download the artifact to open up the docs locally 🎉 I inspected the docs that CI built and they all look good. This PR is also very similar to ~15 other PRs we've merged in the rest of the ecosystem.

This is ready to merge.