You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
Copy file name to clipboardExpand all lines: docs/configuring.rst
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ file of this repository, and can be defined in your project's ``conf.py`` via
26
26
'style_external_links': False,
27
27
'vcs_pageview_mode': '',
28
28
# Toc options
29
-
'collapse_navigation': False,
29
+
'collapse_navigation': True,
30
30
'sticky_navigation': True,
31
31
'navigation_depth': 4,
32
32
'includehidden': True,
@@ -56,12 +56,19 @@ TOC Options
56
56
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
57
57
58
58
* ``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.
60
59
* ``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.
62
62
* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
63
63
* ``titles_only`` Bool. If True, removes headers within a page from the sidebar.
64
64
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.
0 commit comments