Skip to content

Commit e782975

Browse files
kartbencarlescufi
authored andcommitted
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é <[email protected]>
1 parent 3c5f3da commit e782975

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/templates/sample.tmpl

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
.. _descriptive_title_link_name:
1+
.. zephyr:code-sample:: a_unique_id_for_the_sample
2+
:name: A descriptive short name for the sample
3+
:relevant-api: space-separated list of Doxygen groups of APIs this sample is a good showcase of
24

3-
[A Descriptive Title]
4-
#####################
5+
Short text description of the sample. It is recommended to word this as if you were completing
6+
the sentence "This code sample shows how to ...").
57

68
Overview
79
********
8-
[A short description about the sample and what it does]
10+
[A longer description about the sample and what it does]
911

1012
Requirements
1113
************

0 commit comments

Comments
 (0)