IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: correct navigation_depth discription (#609)

Browse Source 
* 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
This commit is contained in:
Aaron Carlisle 2018-04-11 22:04:32 -04:00 committed by GitHub
parent bb82cd22fd
commit 7cd846b4fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/configuring.rst
View File

@ -26,7 +26,7 @@ file of this repository, and can be defined in your project's ``conf.py`` via
'style_external_links': False, 'style_external_links': False,
'vcs_pageview_mode': '', 'vcs_pageview_mode': '',
# Toc options # Toc options
'collapse_navigation': False, 'collapse_navigation': True,
'sticky_navigation': True, 'sticky_navigation': True,
'navigation_depth': 4, 'navigation_depth': 4,
'includehidden': True, 'includehidden': True,
@ -56,12 +56,19 @@ TOC Options
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 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
* ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar. * ``collapse_navigation`` Bool. With this enabled, you will lose the ``[+]`` drop downs next to each section in the sidebar.
This is useful for *very large* documents.
* ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page. * ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
* ``navigation_depth`` Int. Indicate the max depth of the tree; by default, all levels are included. * ``navigation_depth`` Int. Indicate the max depth of the tree; by default, 4 levels are included;
set it to -1 to allow unlimited depth.
* ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option * ``includehidden`` Bool. Specifies if the sidebar includes toctrees marked with the ``:hidden:`` option
* ``titles_only`` Bool. If True, removes headers within a page from the sidebar. * ``titles_only`` Bool. If True, removes headers within a page from the sidebar.
.. note::
Setting ``collapse_navigation`` to False and using a high ``navigation_depth``
can cause projects with many files and a deep file structure to generate HTML files
that are significantly larger in file size and much longer compilation times.
HTML Context Options HTML Context Options
-------------------- --------------------