-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
toctree(...) API changed in Sphinx 7.2 #11607
Copy link
Copy link
Closed
Description
Describe the bug
On Sphinx < 7.2 we were calling toctree(includehidden=True) and it was working fine. However, starting on Sphinx 7.2 it expects the includehidden= parameter to be a string. This was changed in 6f5a99a
I'm opening this issue mainly to ask if this change was on purpose or was a mistake? What's the approach we should follow here? There are other attributes, like titles_only= and collapse= where we are passing boolean as well and that made me doubt about this.
How to Reproduce
I found this issue when running tests for sphinx_rtd_theme while fixing another internal API change at readthedocs/sphinx_rtd_theme#1503
Environment Information
Python 3.10
Sphinx 7.2.0
Sphinx extensions
No response
Additional context
No response
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels