Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flyout menu and other features broken with Sphinx>=6.0 #10242

Closed
dsavransky opened this issue Apr 12, 2023 · 2 comments
Closed

Flyout menu and other features broken with Sphinx>=6.0 #10242

dsavransky opened this issue Apr 12, 2023 · 2 comments
Labels
Support Support question

Comments

@dsavransky
Copy link

Details

Upon adding a .readthedocs.yaml file to my project, I noticed multiple build issues with my html docs. I traced these down to the build system installing very old versions of both sphinx (1.8.6) and the rtd theme (0.4.3). I forced these to be updated by adding documentation requirements, causing the latest versions of both to be installed at build time (6.1.3 and 1.2.0, respectively). However, the html build was still broken in two ways:

  1. The collapse_navigation theme option was being ignored (missing + signs from navigation items)
  2. The flyout menu was present, but would not open when clicked on.

After some experimenting, I was able to fix both of these issues by setting the doc requirement on sphinx to be >4.0<6.0 (effectively forcing 5.3.0 to be installed).

While I see some other people having reported similar issues in the past, I cannot find any version 6-specific bug reports (apologies if a redundant issue already exists).

I've currently set it to build 3 versions: before adding the .yaml file (flyout works, collapse_navigation ignored due to old theme versions); with the 6.1.3 sphinx and 1.2.0 theme (flyout not working, collapse_navigation ignored); and one with 5.3.0 sphinx and 1.2.0 theme (everything works as expected).

Expected Result

I expect 'collapse_navigation': False honored (+ signs appear by navigation menu items), and the flyout menu to open when clicked.

Actual Result

Neither of these happens unless Sphinx 5.3.0 is forced.

@stsewd
Copy link
Member

stsewd commented Apr 12, 2023

Hi, the problem about the flyout menu, is probably because of readthedocs/sphinx_rtd_theme#1452.

@stsewd stsewd added the Support Support question label Apr 12, 2023
douglas-raillard-arm added a commit to douglas-raillard-arm/lisa that referenced this issue Apr 13, 2023
douglas-raillard-arm added a commit to ARM-software/lisa that referenced this issue Apr 13, 2023
@stsewd
Copy link
Member

stsewd commented May 4, 2023

Please subscribe to that other issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Support Support question
Projects
None yet
Development

No branches or pull requests

2 participants