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

Ecosystem: hide qiskit-ui-shell #465

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

I was thinking we can simply set display: none in the CSS to keep things simple and avoid changing the HTML template page.html. But confirm this is accessible for e.g. screen readers.

We also need to update the JavaScript here:

https://github.com/Qiskit/qiskit_sphinx_theme/blob/10fff40263d084e9f09fde008914b3aea31730a5/src/qiskit_sphinx_theme/assets/scripts/qiskit-sphinx-theme.js#L147-L150

We could do this by dynamically checking if qiskit-ui-shell is defined, or maybe if its display is set to none, and set to 0 if so.

Eric-Arellano commented 1 year ago

Everything looks good in https://github.com/Qiskit/qiskit_sphinx_theme/pull/469 except for weirdness with the left side bar.

Screenshot 2023-07-07 at 10 49 07 AM