Merge pull request #74 from timostroehlein/navigation-depth

feat: add toctree_maxdepth option to specify depth shown in sidebar
lepture · Jan 9, 2025 · 9d42f18 · 9d42f18
2 parents 04172bb + 5ddebc7
commit 9d42f18
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -71,7 +71,7 @@ server with:
 
 .. code-block:: shell
 
-    python server.py
+    python serve.py
 
 Build static
 ~~~~~~~~~~~~

diff --git a/docs/customisation/sidebar.rst b/docs/customisation/sidebar.rst
@@ -24,6 +24,7 @@ The above configuration will only expand the first level of the global table of
 Shibuya sphinx theme also provides other options to control the toctree_ function:
 
 - toctree_collapse: equals to ``collapse``, ``False`` by default.
+- toctree_maxdepth: equals to ``maxdepth``, ``4`` by default.
 - toctree_titles_only: equals to ``titles_only``, ``True`` by default
 - toctree_includehidden: equals to ``includehidden``, ``True`` by default
 

diff --git a/src/shibuya/theme/shibuya/layout/default.html b/src/shibuya/theme/shibuya/layout/default.html
@@ -20,7 +20,7 @@
       <div class="sy-scrollbar p-6">
         {%- include "partials/globaltoc-above.html" %}
         <div class="globaltoc" data-expand-depth="{{ theme_globaltoc_expand_depth }}">
-          {%- set globaltoc = toctree(collapse=theme_toctree_collapse, titles_only=theme_toctree_titles_only, includehidden=theme_toctree_includehidden) -%}
+          {%- set globaltoc = toctree(collapse=theme_toctree_collapse, maxdepth=theme_toctree_maxdepth, titles_only=theme_toctree_titles_only, includehidden=theme_toctree_includehidden) -%}
           {{ expandtoc(globaltoc, theme_globaltoc_expand_depth) }}
         </div>
       </div>

diff --git a/src/shibuya/theme/shibuya/theme.conf b/src/shibuya/theme/shibuya/theme.conf
@@ -29,6 +29,7 @@ nav_links_align =
 
 # default global toc collapse
 toctree_collapse =
+toctree_maxdepth = 4
 toctree_titles_only = True
 toctree_includehidden = True
 globaltoc_expand_depth = 0