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 · Sep 6, 2023 · b2977b7 · b2977b7
1 parent 5832f6e
commit b2977b7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/doc/_extensions/zephyr/domain.py b/doc/_extensions/zephyr/domain.py
@@ -142,7 +142,9 @@ def run(self, **kwargs: Any) -> None:
             if len(code_samples) > 0:
                 admonition = nodes.admonition()
                 admonition += nodes.title(text="Related code samples")
+                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 sorted(code_samples, key=lambda x: x["name"]):
                     sample_para = nodes.paragraph()

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.domain",
 ]

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