Qiskit / qiskit_sphinx_theme

A Sphinx theme and documentation guidelines for Qiskit and Qiskit Ecosystem projects
https://qisk.it/docs-guide
Apache License 2.0
15 stars 29 forks source link

Add `qiskit` theme based on Furo #425

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Unblocks https://github.com/Qiskit/qiskit_sphinx_theme/issues/232. With this PR, users will be able to set html_theme = "qiskit" to use Furo.

This PR adds instructions about how to migrate.

It also switches the default theme in qiskit_sphinx_theme's example docs to qiskit. 95% of my work this month has been on Furo, so that's a better default.

Reminder: qiskit_ecosystem theme upcoming

Once we add the Ecosystem theme, only Qiskit itself should use the qiskit theme. In the meantime, everyone should migrate from qiskit_sphinx_theme to qiskit (barring migration issues).