Skip to content
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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Commits on Mar 11, 2023

  1. Introduce navigation_startdepth parameter

    Allows users to start the sidebar Toc at level 0
    
    Addresses issue pydata#1181
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    3303d22 View commit details
    Browse the repository at this point in the history
  2. Make copy of toctree.resolve from Sphinx

    Copy function from toctree.py that needs to be modified (as-is for prettier diffs in future commits)
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    f45c66e View commit details
    Browse the repository at this point in the history
  3. Rewrite toctree.resolve to an internal function

    Rewrite toctree.resolve to an internal function that accepts `toc_caption_maxdepth` as a keyword argument
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    9474176 View commit details
    Browse the repository at this point in the history
  4. Introduce toc_caption_maxdepth parameter

    Use the new local _resolve function and pass it a new keyword argument: `toc_caption_maxdepth`.
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    f855453 View commit details
    Browse the repository at this point in the history
  5. Edit examples to showcase toc_caption_maxdepth

    Edit example pages and show commented out theme-parameters in conf.py
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    7c7ed50 View commit details
    Browse the repository at this point in the history
  6. 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
    SimenZhor committed Mar 11, 2023
    Configuration menu
    Copy the full SHA
    214c047 View commit details
    Browse the repository at this point in the history

Commits on Mar 15, 2023

  1. Add documentation for the new theme options navigation_startdepth a…

    …nd `toc_caption_maxdepth`.
    
    Add gif to show intended behavior of collapsible toc captions.
    SimenZhor committed Mar 15, 2023
    Configuration menu
    Copy the full SHA
    f08f04f View commit details
    Browse the repository at this point in the history

Commits on Mar 18, 2023

  1. Improve compatibility with older versions of Sphinx

    Use `_traverse_or_findall` function instead of assuming `findall` is present.
    SimenZhor committed Mar 18, 2023
    Configuration menu
    Copy the full SHA
    f160219 View commit details
    Browse the repository at this point in the history
  2. 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.
    SimenZhor committed Mar 18, 2023
    Configuration menu
    Copy the full SHA
    5c79b53 View commit details
    Browse the repository at this point in the history
  3. 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.
    SimenZhor committed Mar 18, 2023
    Configuration menu
    Copy the full SHA
    e1cd6b7 View commit details
    Browse the repository at this point in the history