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 moves the sidebar generation logic into a Python function, instead of using a jinja template for it. It uses a recursive function to build sub-lists for children of a page. It also adds an option to include parents of a page, which sets the foundation for a "sidebar-only" version of the theme.
By default, no behavior will change, but this is the new sidebar code:
However, if we use the
include_item_names
variable then the top-level headers will be included in the sidebar. We can use this along withcollapse=False
to grab the full-site TOC if we wish:results in:
As you can see, currently this results in duplicated top-level headers in the sidebar and topbar, but eventually this could be switched on with a
sidebar_only
config value or something like this, that would then remove the top-bar.It also reduces a little bit of CSS redundancy (I think) now that we are using SCSS
What do folks think?