✨ ENH: Make starting depth of sidebar configurable in generated html #309
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This generalizes how we currently select (with
soup.select("li.current.toctree-l1")
the "active" subset of the sphinx-generated html for the sidebar, that allows both disabling it (eg for a single sidebar) as setting it at a higher value (eg for a deeper nested page, where the navbar already selects two levels, eg with dropdown).It adds a
startdepth
keyword for this, following themaxdepth
terminology of sphinx (but we could certainly also go for something more explicit / readable if there are suggestions)