-
Notifications
You must be signed in to change notification settings - Fork 316
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ENH: Add parameters navigation_startdepth
and toc_caption_maxdepth
#1241
base: main
Are you sure you want to change the base?
Commits on Mar 11, 2023
-
Introduce
navigation_startdepth
parameterAllows users to start the sidebar Toc at level 0 Addresses issue pydata#1181
Configuration menu - View commit details
-
Copy full SHA for 3303d22 - Browse repository at this point
Copy the full SHA 3303d22View commit details -
Make copy of
toctree.resolve
from SphinxCopy function from toctree.py that needs to be modified (as-is for prettier diffs in future commits)
Configuration menu - View commit details
-
Copy full SHA for f45c66e - Browse repository at this point
Copy the full SHA f45c66eView commit details -
Rewrite toctree.resolve to an internal function
Rewrite toctree.resolve to an internal function that accepts `toc_caption_maxdepth` as a keyword argument
Configuration menu - View commit details
-
Copy full SHA for 9474176 - Browse repository at this point
Copy the full SHA 9474176View commit details -
Introduce
toc_caption_maxdepth
parameterUse the new local _resolve function and pass it a new keyword argument: `toc_caption_maxdepth`.
Configuration menu - View commit details
-
Copy full SHA for f855453 - Browse repository at this point
Copy the full SHA f855453View commit details -
Edit examples to showcase
toc_caption_maxdepth
Edit example pages and show commented out theme-parameters in conf.py
Configuration menu - View commit details
-
Copy full SHA for 7c7ed50 - Browse repository at this point
Copy the full SHA 7c7ed50View commit details -
Update heading of sidebar-nav-bs.html
Change heading of sidebar-nav depending on `theme_navigation_startdepth`. Shows "Site Navigation" when startdepth=0 or "Section Navigation" otherwise
Configuration menu - View commit details
-
Copy full SHA for 214c047 - Browse repository at this point
Copy the full SHA 214c047View commit details
Commits on Mar 15, 2023
-
Add documentation for the new theme options
navigation_startdepth
a……nd `toc_caption_maxdepth`. Add gif to show intended behavior of collapsible toc captions.
Configuration menu - View commit details
-
Copy full SHA for f08f04f - Browse repository at this point
Copy the full SHA f08f04fView commit details
Commits on Mar 18, 2023
-
Improve compatibility with older versions of Sphinx
Use `_traverse_or_findall` function instead of assuming `findall` is present.
Configuration menu - View commit details
-
Copy full SHA for f160219 - Browse repository at this point
Copy the full SHA f160219View commit details -
Improve compatibility with older versions of Sphinx
Remove test for references to non-included documents. This feature was introduced sometime between Sphinx 5 and 6 apparently.
Configuration menu - View commit details
-
Copy full SHA for 5c79b53 - Browse repository at this point
Copy the full SHA 5c79b53View commit details -
Improve compatibility with newer versions of Sphinx
When `TocTree._toctree_prune` does not exist, use approach from Sphinx 6.1.3 for pruning the toctree.
Configuration menu - View commit details
-
Copy full SHA for e1cd6b7 - Browse repository at this point
Copy the full SHA e1cd6b7View commit details