From e7829752ae5db73a384ce59aecba71024e85489e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Tue, 5 Sep 2023 18:57:22 +0200 Subject: [PATCH] doc: Update sample.tmpl with new directive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the sample.tmpl file so that it encourages people to use the new :zephyr:code-sample: directive. Signed-off-by: Benjamin Cabé --- doc/templates/sample.tmpl | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) 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 ************