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.