Skip to content

Commit

Permalink
doc: Update sample.tmpl with new directive
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
kartben authored and carlescufi committed Sep 6, 2023
1 parent 3c5f3da commit e782975
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/templates/sample.tmpl
Original file line number Diff line number Diff line change
@@ -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
************
Expand Down

0 comments on commit e782975

Please sign in to comment.