Search code examples
python-sphinxbootstrap-themes

What's the right way to declare maximumdepth for the globaltoc using sphinx-bootstrap-theme?


I´m trying to run sphinx-bootstrap-theme from Ryan Romer and anything goes on the right way, but the globaltoc maximumdepth; I could not fix that in a value differente than one.

from conf.py

'globaltoc_depth': "3",

'globaltoc_includehidden': "true",

from theme.config

globaltoc_includehidden = true

navbar_fixed_top = false

Solution

  • Do not place quote marks around integers. Doing so casts them to strings. See the theme-options for readme for sphinx-bootstrap-theme.

    The correct values in conf.py should be:

    "globaltoc_depth": 3,
    "globaltoc_includehidden": "true",
    

    Strangely the same does not hold for booleans in the configuration. If you don't get what you want, try changing to:

    "globaltoc_includehidden": True,