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
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 ...").
7
8Overview
9********
10[A longer description about the sample and what it does]
11
12Requirements
13************
14[List of required software and hardware components. Provide pointers to
15hardware components such as sensors and shields]
16
17Wiring
18******
19[For simple projects, a description of how to wire the board for the demo. For
20complex projects, provide a graphic with more details, preferably using
21Fritzing or some other visualisation tools]
22
23Building and Running
24********************
25[ How to build the sample and how to run it. Pointers to where to find the
26sample in the source tree and how to configure it and run it for a specific
27target platform]
28
29[When showing code-blocks with sample build command instructions, use the
30..zephyr-app-commands directive (see the doc guidelines) instead of a
31hand-written code-block.]
32
33References
34**********
35[ Links to external references such as datasheets or additional documentation]
36
37
38