Merge pull request #181 from f5devcentral/override-sidebar-maxdepth

Added ability to override 'maxdepth' on sidebar
f5devcentral · Feb 23, 2023 · c1e0636 · c1e0636
2 parents 0c694d9 + 5d07574
commit c1e0636
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -22,11 +22,12 @@ Setup and Configuration
                             'site_name': '<desired site name>',           \\ DEFAULTS TO "CloudDocs home"
                             'next_prev_link': True or False,              \\ DEFAULTS TO FALSE
                             'html_last_updated_fmt': '%Y-%m-%d %H:%M:%S', \\ REQUIRED FOR FEDERATED SEARCH, DO NOT CHANGE
-                            # 'surveymonkey_url' = '',                    \\ DEFAULTS TO ""
-                            # 'medallia_embed_url' = '',                  \\ DEFAULTS TO ""
+                            # 'surveymonkey_url' = '',                    \\ DEFAULTS TO ''
+                            # 'medallia_embed_url' = '',                  \\ DEFAULTS TO ''
                             # 'medallia_id' = '',                         \\ DEFAULTS TO "medallia_inline_survey"
                             # 'feedback_exclude_pages': ['page.html'],    \\ DEFAULTS TO ['index.html', 'search.html'], THE TABLE OF CONTENTS AND SEARCH PAGE
-                            # 'base_url' = ''                             \\ DEFAULTS TO '/'
+                            # 'base_url' = ''                             \\ DEFAULTS TO '/',
+                            # 'sidebar_toc_maxdepth' = ''                 \\ DEFAULTS TO '', Override 'maxdepth' behavior on sidebar toc in layout.html. This is an integer value.
                          }
 
    \

diff --git a/f5_sphinx_theme/__init__.py b/f5_sphinx_theme/__init__.py
@@ -16,7 +16,7 @@
 from os import path
 
 
-__version__ = "2.2.3"
+__version__ = "2.2.4"
 
 
 def get_html_theme_path():

diff --git a/f5_sphinx_theme/layout.html b/f5_sphinx_theme/layout.html
@@ -69,7 +69,7 @@ <h5>{{ project }} {{ version }} </h5>
         {%- include "searchbox.html" %}
         <hr>
         <span class="nav-sidebartoc">
-          {{ toctree(includehidden=True, collapse=True) }}
+          {{ toctree(includehidden=True, collapse=True, maxdepth=theme_sidebar_toc_maxdepth|int) }}
         </span>
         {%- include "extralinks.html" %}
       </nav>

diff --git a/f5_sphinx_theme/theme.conf b/f5_sphinx_theme/theme.conf
@@ -12,3 +12,4 @@ surveymonkey_url =
 medallia_embed_url =
 medallia_id = medallia_inline_survey
 feedback_exclude_pages = ['index.html', 'search.html']
+sidebar_toc_maxdepth =