Collapse API Reference sidebar section by default - #14
Merged
Conversation
navigation.expand expands every nav section; a small extra_javascript snippet strips the expansion from the API Reference subtree on load so the large generated module tree starts collapsed while the notebook sections stay expanded. The active trail is kept open on API pages. Claude-Session: https://claude.ai/code/session_01CPvMrqdjt98QMvvoAQqRcz
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The generated API module tree is overwhelming when fully expanded, while the notebook sections are the most instructive part of the docs and should stay open.
Since Material's
navigation.expandis all-or-nothing, this keeps it enabled and adds a smallextra_javascriptsnippet that strips the expansion markers (md-toggle--indeterminate) from the API Reference subtree on page load. Clicking still toggles normally, and the active trail stays open when browsing API pages themselves.Verified against a full
mkdocs build(notebook execution disabled): only the API Reference toggles are collapsed, Notebooks untouched, active trail preserved on reference pages.