Control max depth for sidebar that includes autosummary content

[adamcunnington-mlg]

Thanks for the great theme!

My sidebar is built like this:

.. toctree::
    :hidden:

    Home <self>
    API Reference <api>

but <api> contains:

.. autosummary::
   :recursive:
   :template: module.rst
   :toctree: generated

   bqtemplatemanager

The problem is that the sidebar can then be very deep - and :maxdepth: doesn't seem to do anything. The result is ugly stlying:

[pradyunsg]

Got a reproducer or sample website for me to look at?

[adamcunnington-mlg]

@pradyunsg sure; https://medialabgroup.gitlab.io/apollo/bq-template-manager/generated/bqtemplatemanager.html

[pradyunsg]

Furo intentionally presents the entire site structure provided to it -- to avoid having "hidden" parts to the documentation site.

If you still want to exclude auto-generated content from the toctree, I think the right tool for that is https://github.com/executablebooks/sphinx-remove-toctrees.

[adamcunnington-mlg]

@pradyunsg got it - but do you think you could improve the styling? As you saw from the site, long links overlap with the arrow dropdown. When you hover over the dropdown, they are truncated which looks much nicer. Perhaps you can style so this behaviour happens by default, maybe using an ellipsis to indicate extra content is hidden?

I don't want to hide the auto-generated content from the sidebar, I just want it to render nicer.

[pradyunsg]

Done in fcd6ff6. :)

[KelSolaar]

Text ellipsis can be done with a custom.css file with the following content:

.sidebar-tree .reference {
    overflow: hidden;
    text-overflow: ellipsis;
    white-space: nowrap;
    word-break: normal;
}

[pradyunsg]

Not hiding page titles behind ellipsis is intentional.