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

Add navigation_depth to readme docs (#508)

Browse Source 
Fixes #231
This commit is contained in:
Aaron Carlisle 2017-12-18 09:35:13 -05:00 committed by GitHub
parent 90dce37ce1
commit c1fca38f55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -108,24 +108,26 @@ Base options
~~~~~~~~~~~~ ~~~~~~~~~~~~
* ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts. * ``typekit_id`` This will let users specify a typekit id to use for displaying nicer fonts.
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__ * ``canonical_url`` String. This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs. to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash. The url points to the root of the documentation and requires a trailing slash.
* ``analytics_id`` Change the Google Analytics ID that is included on pages. * ``analytics_id`` String. Change the Google Analytics ID that is included on pages.
* ``display_version`` With this disabled, the version number isn't shown at the top of the sidebar. * ``display_version`` Bool. With this disabled, the version number isn't shown at the top of the sidebar.
* ``prev_next_buttons_location`` can take the value ``bottom``, ``top``, ``both`` , or ``None`` * ``prev_next_buttons_location`` String. can take the value ``bottom``, ``top``, ``both`` , or ``None``
and will display the "Next" and "Previous" buttons accordingly and will display the "Next" and "Previous" buttons accordingly.
* ``style_external_links`` Add an icon next to external links. Defaults to ``False``. * ``style_external_links`` Bool. Add an icon next to external links. Defaults to ``False``.
TOC Options 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`` With this enabled, you will lose the `[+]` drop downs next to each section in the sidebar. This is useful for _very large_ documents. * ``collapse_navigation`` Bool. With this enabled, you will lose the `[+]` drop downs next to each section in the sidebar.
* ``sticky_navigation`` This causes the sidebar to scroll with the main page content as you scroll the page. This is useful for _very large_ documents.
* ``includehidden`` Specifies if the sidebar includes toctrees marked with the `:hidden:` option * ``sticky_navigation`` Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
* ``titles_only`` If True, removes headers within a page from the sidebar. * ``navigation_depth`` Int. Indicate the max depth of the tree; by default, all levels are included.
* ``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.
Page-level configuration Page-level configuration
------------------------ ------------------------