Fix hamburger menu and fix local/global toc split #107
Conversation
This file contains 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
Previously, the entire branch of the global TOC corresponding to the
current page was split off and made into the local TOC, then pruned to
exclude the children of other pages. Any sub-pages were excluded from
the global TOC.
With this commit, the local TOC will exclude all external links, while
the global TOC will contain any external links, along with any local
sections that transitively contain external links.
For example, given the structure:
a.rst:
A
=
Section 1
----------
.. toctree::
b
Old global TOC:
A
Old local TOC:
Section 1
b
New global TOC:
A
Section 1
b
New local TOC:
A
Section 1
Previously, the TOC nodes corresponding to any sections within a page were also marked as "active" and "current". The mkdocs-material hamburger menu was not designed to accommodate more than a single path from the root of TOC nodes marked active, resulting in the menus for multiple sections being shown on top of each other at the same time, leading to confusing and incorrect behavior with the back buttons. With this change, sections within a page are not marked active or current, which fixes the hamburger menu.
2bndy5
approved these changes
May 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fixes the hamburger menu issue identified by @2bndy5 in #99.
Unfortunately, this fix does not work for the case where a Sphinx page has multiple top-level sections (rather than a single "title"). The design of the hamburger menu in the mkdocs-material theme does not seem to be able to accommodate that possibility.