search

executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
406 stars 196 forks source link

Sidebar Navigation Arrows Not Rotating on Click in Jupyter Book #827

Open mscharling opened 3 months ago

mscharling commented 3 months ago

Describe the bug

Context When I navigate the sidebar in Jupyter Book by expanding or collapsing sections.

Expectation I expected the arrows next to the sidebar items to rotate or change direction, indicating whether the sections are expanded or collapsed.

Bug But instead, the arrows remain static and do not change their orientation, regardless of the section's state. This issue persists across different chapters and is unrelated to specific content. There is no error message in the console related to this, but it's a UI inconsistency.

Problem This is a problem for users because the static arrows can cause confusion about the current state of the navigation menu, impacting the user experience and making navigation less intuitive. It is especially challenging for new users who rely on visual cues for navigation.

Video of problem https://gyazo.com/e361209eae5e552e4375206540b03752

Reproduce the bug

  1. Set up a Jupyter Book with multiple chapters or sections, ensuring that some chapters have sub-sections.
  2. Open the Jupyter Book in a web browser.
  3. Locate the navigation sidebar which contains the chapters and their expandable sub-sections.
  4. Click on the arrow next to a chapter title to expand or collapse the sub-sections under that chapter.
  5. Observe the behavior of the arrow icon next to the chapter title during this interaction.

List your environment

Jupyter Book : 0.15.1 External ToC : 0.3.1 MyST-Parser : 0.18.1 MyST-NB : 0.17.2 Sphinx Book Theme : 1.0.1 Jupyter-Cache : 0.6.1 NbClient : 0.7.4

welcome[bot] commented 3 months ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: