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

Rename options to make clear what is Qiskit specific? #549

Closed Eric-Arellano closed 5 months ago

Eric-Arellano commented 1 year ago

It'd probably be useful to include the word qiskit in the options:

https://github.com/Qiskit/qiskit_sphinx_theme/blob/4847a8130769638659404b29ff95c689991d5d54/src/qiskit_sphinx_theme/previous_releases.py#L29 https://github.com/Qiskit/qiskit_sphinx_theme/blob/4847a8130769638659404b29ff95c689991d5d54/src/qiskit_sphinx_theme/translations.py#L32 https://github.com/Qiskit/qiskit_sphinx_theme/blob/4847a8130769638659404b29ff95c689991d5d54/src/qiskit_sphinx_theme/__init__.py#L78

https://github.com/Qiskit/qiskit_sphinx_theme/blob/4847a8130769638659404b29ff95c689991d5d54/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/theme.conf#L27

Since this goes along with a Qiskit 2.0 change—and we pinned every user to Qiskit 1.0—it's probably fine to not offer the old names anymore, to keep our code simpler.

The README needs an update.

Eric-Arellano commented 5 months ago

I don't think this is worth the disruption.