diff --git a/doc/templates/sample.tmpl b/doc/templates/sample.tmpl index c3b59b8990..e8560b03c4 100644 --- a/doc/templates/sample.tmpl +++ b/doc/templates/sample.tmpl @@ -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 ************