Skip to content

toctree(...) API changed in Sphinx 7.2 #11607

@humitos

Description

@humitos

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions