-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Labels
Support
Support question
Comments
Hi, the problem about the flyout menu, is probably because of readthedocs/sphinx_rtd_theme#1452. |
douglas-raillard-arm
added a commit
to douglas-raillard-arm/lisa
that referenced
this issue
Apr 13, 2023
Apply Workaround for broken flyout menu. Bug report: readthedocs/readthedocs.org#10242 Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
douglas-raillard-arm
added a commit
to ARM-software/lisa
that referenced
this issue
Apr 13, 2023
Apply Workaround for broken flyout menu. Bug report: readthedocs/readthedocs.org#10242 Workaround: readthedocs/sphinx_rtd_theme#1452 (comment)
Please subscribe to that other issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
collapse_navigation
theme option was being ignored (missing + signs from navigation items)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.
The text was updated successfully, but these errors were encountered: