Section Navigation - don't show hidden TOC items?

[jklymak]

In Matplotlib, we have an index page with a hidden toctree to make sure the pages are indexed, but they don't appear in the usual tree. However, despite being hidden, these show up in the Section navigation. So in https://matplotlib.org/devdocs/users/index.html

the last three entries are from

.. toctree::
    :hidden:

    explain/index
    getting_started/index
    installing/index

and we do not want them showing up in the Section Navigation. Is there a setting for this, or is this a feature request? Thanks!

[drammock]

I think the config setting sidebar_includehidden=False will do what you want. Can you try that and let us know if it resolves the issue?

[jklymak]

I can also try and look at it, but like you probably mid December!

[FranzRoters]

It seems that this functionality is broken in 0.15.1, now hidden toc items are never shown independant of the value of sidebar_includehidden. According to the docs https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#references True should still be the default.

[drammock]

the fix for this (hopefully! I don't think @jklymak has tested it yet) was included in #1632, so @FranzRoters if you can test out current main of the theme it would be useful to know if the problem persists. (pip install -U https://github.com/pydata/pydata-sphinx-theme/archive/refs/heads/main.zip)

[FranzRoters]

Indeed, I can confirm that this is fixed in 0.15.2.dev0

[drammock]

Thanks for confirming!