doc: Make code-samples admonition collapsible

Use sphinx-toggle to make "Related code samples" collapsible. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
zephyrproject-rtos · Aug 30, 2023 · 76177ff · 76177ff
1 parent 8630db5
commit 76177ff
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/doc/_extensions/zephyr/code-sample.py b/doc/_extensions/zephyr/code-sample.py
@@ -96,7 +96,9 @@ def process_related_code_sample_nodes(app, doctree, fromdocname):
         if len(code_samples) > 0:
             admonition = nodes.admonition()
             admonition += nodes.title(text="Related code samples")
-            admonition["collapsible"] = ""
+            admonition["collapsible"] = "" # used by sphinx-immaterial theme
+            admonition["classes"].append("related-code-samples")
+            admonition["classes"].append("dropdown") # used by sphinx-togglebutton extension
             sample_ul = nodes.bullet_list()
             for code_sample in code_samples:
                 # Create a list item such as:

diff --git a/doc/conf.py b/doc/conf.py
@@ -84,6 +84,7 @@
     "zephyr.vcs_link",
     "notfound.extension",
     "sphinx_copybutton",
+    "sphinx_togglebutton",
     "zephyr.external_content",
     "zephyr.code-sample",
 ]

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -8,6 +8,7 @@ sphinxcontrib-svg2pdfconverter
 pygments>=2.9
 sphinx-notfound-page
 sphinx-copybutton
+sphinx-togglebutton
 
 # YAML validation. Used by zephyr_module.
 PyYAML>=5.1