ryan-roemer/sphinx-bootstrap-theme

Could localtoc in sidebar support depth option?

Open

#169 opened on Nov 28, 2017

View on GitHub
 (2 comments) (1 reaction) (0 assignees)HTML (213 forks)batch import
featurehelp wanted

Repository metrics

Stars
 (587 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

For a page contains lots of headings and subheadings, if we generate localtoc in sidebar, the sidebar would be too long to display and it doesn't support scroll well, sometimes even overflows the footer. So, could localtoc support a depth option and then we can control the length of sidebar?

Contributor guide

Research direction
Find how localtoc is generated in the theme templates and add a depth parameter to limit heading levels.
Tech stack
None
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SphinxPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65