Qiskit / qiskit-metapackage

Qiskit is an open-source SDK for working with quantum computers at the level of circuits, algorithms, and application modules.
https://qiskit.org
Apache License 2.0
3.03k stars 750 forks source link

Update repo to use new qiskit sphinx theme #1631

Closed javabster closed 1 year ago

javabster commented 1 year ago

Summary

The latest version of the qiskit_sphinx_theme (1.10.0) includes 2 major new features:

This PR removes the existing docs/templates/layout.html so that terra will stop overriding the qiskit_sphinx_theme and enable the new top menu to show. This PR also updates the conf.py to opt-in to analytics (details on what is tracked here)

I also updated the headings in the left sidebar, because some pages (e.g. tutorials) are specific to terra and not present in the new unified top bar. Similarly other pages (like contributing things) are relevant to all repos and are linked in the new top menu so don't need to be in the sidebar anymore.

Not sure if I did the env var setting the way you meant @mtreinish 😅

Details and comments

javabster commented 1 year ago

my suggested new sidebar layout, based on the diataxis framework we are trying to follow going forward.

Screenshot 2022-11-22 at 5 33 01 PM
javabster commented 1 year ago

thanks for the comments @jakelishman @HuangJunye ! I think i've addressed them all, lmk if theres anything else 😄

HuangJunye commented 1 year ago

I am not tagging automerge in case @jakelishman and others want to have a final look.