Skip to content

Commit 7cd846b

Browse files
authored
Docs: correct navigation_depth discription (#609)
* Docs: correct navigation_depth discription * Docs: add note about large toctrees * Docs: Cleanup: use different note markup Github does not mark the syntax correctly otherwise
1 parent bb82cd2 commit 7cd846b

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/configuring.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ file of this repository, and can be defined in your project's ``conf.py`` via
2626
'style_external_links': False,
2727
'vcs_pageview_mode': '',
2828
# Toc options
29-
'collapse_navigation': False,
29+
'collapse_navigation': True,
3030
'sticky_navigation': True,
3131
'navigation_depth': 4,
3232
'includehidden': True,
@@ -56,12 +56,19 @@ TOC Options
5656
These effect how we display the Table of Contents in the side bar. You can read more about them here: http://www.sphinx-doc.org/en/stable/templating.html#toctree
5757

5858
* ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar.
59-
This is useful for *very large* documents.
6059
* ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
61-
* ``navigation_depth`` Int. Indicate the max depth of the tree; by default, all levels are included.
60+
* ``navigation_depth`` Int. Indicate the max depth of the tree; by default, 4 levels are included;
61+
set it to -1 to allow unlimited depth.
6262
* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
6363
* ``titles_only`` Bool. If True, removes headers within a page from the sidebar.
6464

65+
.. note::
66+
67+
Setting ``collapse_navigation`` to False and using a high ``navigation_depth``
68+
can cause projects with many files and a deep file structure to generate HTML files
69+
that are significantly larger in file size and much longer compilation times.
70+
71+
6572
HTML Context Options
6673
--------------------
6774

0 commit comments

Comments
 (0)