Allow for Contents header depth to be specified about furo HOT 4 CLOSED

Relevant line of code, in the theme's markup:

from furo.

Thanks for filing this! ^.^

On the one hand, I totally understand why this would be useful.

On the other hand, currently Furo is basically using the Sphinx-provided markup directly which provides the entire TOC without any configurability.

Enabling this would be a fairly significant chunk of complexity (parse + modify html given by sphinx), which I'm not too excited by. Similar feelings for some "make a choice" discussions (per page vs site-wide) around adding any configuration knob like this as well. There's a hidden cost to adding configuration options and I'd like to treat that as pretty high for Furo.

Maybe you would want to use Rubrics, once they get stylised properly (per #33) to avoid unwanted headings being added into the TOC for a page, but still being visually title-like?

from furo.

Thanks, I will take a look!

from furo.

@Br4nd0R I reckon Rubrics are the way to go here. I'll add proper support in the next release -- which should be over the weekend.

Do feel free to reopen if you disagree (assuming GitHub lets you). :)

from furo.