From c17f00c7a26975d09f1c3d3617b36e99aa0a2aeb Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Mon, 13 Apr 2020 19:22:17 +0200 Subject: [PATCH] DOC: globaltoc_collapse, globaltoc_includehidden --- doc/usage/theming.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/usage/theming.rst b/doc/usage/theming.rst index 5ed9f1f1b..e9d57abbb 100644 --- a/doc/usage/theming.rst +++ b/doc/usage/theming.rst @@ -155,6 +155,21 @@ These themes are: previous/next page using the keyboard's left and right arrows. Defaults to ``False``. + .. versionadded:: 3.1 + + The following options: + + - **globaltoc_collapse** (true or false): Only expand subsections + of the current document in ``globaltoc.html`` + (see :confval:`html_sidebars`). + Defaults to ``True``. + + - **globaltoc_includehidden** (true or false): Show even those + subsections in ``globaltoc.html`` (see :confval:`html_sidebars`) + which have been included with the ``:hidden:`` flag of the + :rst:dir:`toctree` directive. + Defaults to ``False``. + **alabaster** `Alabaster theme`_ is a modified "Kr" Sphinx theme from @kennethreitz (especially as used in his Requests project), which was itself originally