zephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: Update sample.tmpl with new directive 

Update the sample.tmpl file so that it encourages people to use the new
:zephyr:code-sample: directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-09-05 18:57:22 +02:00 committed by Carles Cufí
parent 3c5f3da4d8
commit e7829752ae
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/templates/sample.tmpl vendored
View File

@ -1,11 +1,13 @@
.. _descriptive_title_link_name:
.. zephyr:code-sample:: a_unique_id_for_the_sample
:name: A descriptive short name for the sample
:relevant-api: space-separated list of Doxygen groups of APIs this sample is a good showcase of
[A Descriptive Title]
#####################
Short text description of the sample. It is recommended to word this as if you were completing
the sentence "This code sample shows how to ...").
Overview
********
[A short description about the sample and what it does]
[A longer description about the sample and what it does]
Requirements
************