Limiting sidebar TOC depth in Sphinx HTML builder

Question

I'm trying to limit the depth of sidebar toc generated by Sphinx HTML Biulder. I tried to change localsidebar.html with my own but I couldn't find any hints in the documentation, just the deprecated options. {{ toc }} contains rendered local toc but there's no info about how to work with it before it gets rendered.

Have you had any success so far? I have the same question.

creimers
– creimers

2014-06-05 11:15:52 +00:00
Commented Jun 5, 2014 at 11:15 — creimers
– creimers, Commented Jun 5, 2014 at 11:15
@creimers unfortunately no.

minder
– minder

2014-06-05 22:29:41 +00:00
Commented Jun 5, 2014 at 22:29 — minder
– minder, Commented Jun 5, 2014 at 22:29

Nicholas Bishop · Accepted Answer · 2016-08-27 06:29:09Z

3

Try putting the following line at the top of the file:

:tocdepth: <n>

with <n> being the depth you want.

edited Aug 27, 2016 at 6:29

Nicholas Bishop

1,1519 silver badges23 bronze badges

answered Aug 15, 2014 at 10:51

Abin Stein

312 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Brad Porter · Accepted Answer · 2017-09-10 05:27:28Z

I've seen the best sidebar results by setting maxdepth in the theme customizations in _templates/layout.html. No extra directive options are needed in the rst toctree file hierarchy.

{%- block sidebartoc %} {{ toctree(collapse=False,maxdepth=2) }} {%- endblock %}

Collectives™ on Stack Overflow

Limiting sidebar TOC depth in Sphinx HTML builder

2 Answers 2

Comments

Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Related