search

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
14 stars 29 forks source link

Add a customisable announcement banner component for the ecosystem theme #535

Closed javabster closed 1 year ago

javabster commented 1 year ago

https://github.com/Qiskit/qiskit_sphinx_theme/pull/530 added a banner for announcements to the main qiskit theme, it would be nice to add one for the ecosystem theme to :D

Eric-Arellano commented 1 year ago

Are you sure we need this? It's more code to support and document. I'd encourage us to only add it if users explicitly asked for it.

Eric-Arellano commented 1 year ago

Given that we're de-emphasizing the qiskit theme in favor of the qiskit-ecosystem theme, I suspect it will be sufficient for projects to use Furo's built-in announcement banner mechanism: https://pradyunsg.me/furo/customisation/announcement/. The Ecosystem theme doesn't have the custom Qiskit nav bar, so the design should work out better.

If Furo's builtin announcement doesn't work, we can always reopen this :)

The motivation to close this is to have less custom code to maintain.