executablebooks / sphinx-design

A sphinx extension for designing beautiful, screen-size responsive web components.
https://sphinx-design.readthedocs.io/en/furo-theme/
MIT License
192 stars 60 forks source link

option to include card/grid headers in toc tree #134

Open story645 opened 1 year ago

story645 commented 1 year ago

Context

Hi, over at Matplotlib we maybe overly use cards and grids to organize information, e.g. landing page, contribute page and it's awesome except it makes the right hand navigation panel very sparse.

Proposal

Would it be feasible to add a directive that could tell sphinx to parse the title into a heading level that can then be included in a toctree? something like :toctree-level:? Or a css class variable sd-toctree-level-{}?

Tasks and updates

No response

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: