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 (587 stars) (213 forks)batch import
featurehelp wanted

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

Tech stack
pythonhtmlcss
Domain
frontenddocumentation
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of Sphinx theme development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Look into the theme's template files, likely 'layout.html' or 'localtoc.html' in the repository, to find where the local table of contents is rendered. The depth option would need to be added to the Sphinx configuration and passed to the template. Check the existing 'localtoc' implementation in the Sphinx documentation or theme documentation. Consider adding a 'depth' parameter in 'theme.conf' and then using it in the Jinja template to limit heading levels shown. Also review any existing PRs or discussions about this feature.