Customise parameters used to generate sidebar toctree

[alexisthual]

Currently, furo overwrites rst files' toctree parameters when it generates the sidebar toctree:

furo/src/furo/__init__.py

Lines 97 to 110 in d6b217f

	def _compute_navigation_tree(context: Dict[str, Any]) -> str:
	# The navigation tree, generated from the sphinx-provided ToC tree.
	if "toctree" in context:
	toctree = context["toctree"]
	toctree_html = toctree(
	collapse=False,
	titles_only=True,
	maxdepth=-1,
	includehidden=True,
	)
	else:
	toctree_html = ""
	return get_navigation_tree(toctree_html)

We at nilearn plan on using furo, but would like to keep the original parameters we set in the rst files.
What do you think is the best way for us to achieve this? Would it make sense that furo removes this parameters altogether by default and enable setting them in conf.py? This is actually what we would need as different sections of our toctree have different parameters.

Thank you for the very nice theme and maintenance anyways 😄

[pradyunsg]

Hiya! Please see #117 (comment). :)

Basically, it's an opinionated choice to ensure that the entire site structure is presented in the sidebar.

[alexisthual]

It's very nice that the theme comes with opinionated defaults, but I think there are some cases where users might need to overwrite these.
For instance, titles_only=True actually filters out part of our site structure, and so does max_depth=2 (which, in our case, we need to increase).

[pradyunsg]

See #146 (comment) for the rationale behind titles_only=True. There is no way to change that. There is also no max_depth=2 in this codebase, as far as I know.

[pradyunsg]

See also #155 (comment).

[pradyunsg]

And, finally, #79 (comment).

[alexisthual]

See #146 (comment) for the rationale behind titles_only=True. There is no way to change that. There is also no max_depth=2 in this codebase, as far as I know.

Oops, my bad about max_depth.

I understand your position, and think it makes sense to expose the website's true structure.
In my case, I changed the site's structure to obtain what I wanted.
However, I still think it would be nice that users can tweak this, and that the theme does not enforce it. As a user, what I want from furo is clean css (I really love the design 😄 ), but I don't want it to make other strong choices for me.