diff --git a/README.rst b/README.rst index bdf802db..76027ed2 100644 --- a/README.rst +++ b/README.rst @@ -7,6 +7,7 @@ .. _grunt: http://www.gruntjs.com .. _node: http://www.nodejs.com .. _demo: http://docs.readthedocs.org +.. _hidden: http://sphinx-doc.org/markup/toctree.html ************************** Read the Docs Sphinx Theme @@ -23,7 +24,6 @@ the SASS files here, rather than the .css files on RTD. .. image:: screen_mobile.png :width: 100% - Installation ============ @@ -69,6 +69,10 @@ It's important to note that if you don't follow the same styling for your rST he your documents, the toctree will misbuild, and the resulting menu might not show the correct depth when it renders. +Also note that the table of contents is set with ``includehidden=true``. This allows you +to set a hidden toc in your index file with the hidden_ property that will allow you +to build a toc without it rendering in your index. + Contributing or modifying the theme =================================== diff --git a/sphinx_rtd_theme/layout.html b/sphinx_rtd_theme/layout.html index 71908898..0314a802 100644 --- a/sphinx_rtd_theme/layout.html +++ b/sphinx_rtd_theme/layout.html @@ -101,7 +101,7 @@
- {% set toctree = toctree(maxdepth=2, collapse=False) %} + {% set toctree = toctree(maxdepth=2, collapse=False, includehidden=True) %} {% if toctree %} {{ toctree }} {% else %}