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 `Site contents` to `Site` in mobile header #489

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

Prework for the Ecosystem Theme showing the project name in the https://github.com/Qiskit/qiskit_sphinx_theme/issues/484.

When adding the project name back, Site contents takes up too much space and makes the header look crowded. So, we need a shorter name.

I also considered Contents and Menu, but they both are too ambiguous. We can't use ToC because we can't use abbreviations.

--

This also uses CSS rather than HTML to hide the project name. That makes it much easier to add it back in the Ecosystem.

Eric-Arellano commented 1 year ago

We decided to use a hamburger icon like Furo does for the Ecosystem theme, so this PR is not relevant.

For the Qiskit theme, we thought Site contents is slightly more clear than Site. And we don't have any concerns about it taking too much space.