ryan-roemer/sphinx-bootstrap-theme

Could localtoc in sidebar support depth option?

Open

#169 opened on 2017年11月28日

GitHub で見る
 (2 comments) (1 reaction) (0 assignees)HTML (587 stars) (213 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.