ryan-roemer/sphinx-bootstrap-theme

Could localtoc in sidebar support depth option?

Open

#169 创建于 2017年11月28日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)HTML (587 star) (213 fork)batch import
featurehelp wanted

描述

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?

贡献者指南

技术栈
pythonhtmlcss
领域
frontenddocumentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
knowledge of Sphinx theme development
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
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.
Could localtoc in sidebar support depth option? · ryan-roemer/sphinx-bootstrap-theme#169 | Good First Issue