michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Make code-samples admonition collapsible

Browse source 
Use sphinx-toggle to make "Related code samples" collapsible.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-08-30 09:26:48 +02:00 • committed by Carles Cufí
commit b2977b7657
3 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/_extensions/zephyr/domain.py
View file

@ -142,7 +142,9 @@ class ProcessRelatedCodeSamplesNode(SphinxPostTransform):
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()

1
doc/conf.py
View file

@ -84,6 +84,7 @@ extensions = [
"zephyr.vcs_link",
"notfound.extension",
"sphinx_copybutton",
"sphinx_togglebutton",
"zephyr.external_content",
"zephyr.domain",
]

1
doc/requirements.txt
View file

@ -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