From 79674debcbcab7f33f88fe093fb240b35a4a128f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Thu, 28 Sep 2023 14:20:15 +0200 Subject: [PATCH] samples: bindesc: doc: Describe sample using zephyr:code-sample MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Describe the code sample using zephyr:code-sample directive to help with making it easier to find from API reference. Also cross-referenced main bindesc page from the sample. Signed-off-by: Benjamin Cabé --- samples/subsys/bindesc/hello_bindesc/README.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/samples/subsys/bindesc/hello_bindesc/README.rst b/samples/subsys/bindesc/hello_bindesc/README.rst index 5934b3f0ca6..f2cd9e2d16e 100644 --- a/samples/subsys/bindesc/hello_bindesc/README.rst +++ b/samples/subsys/bindesc/hello_bindesc/README.rst @@ -1,12 +1,13 @@ -.. _hello_bindesc-sample: +.. zephyr:code-sample:: hello-bindesc + :name: Binary descriptors "Hello World" + :relevant-api: bindesc_define -hello_bindesc Sample Application -################################ + Set and access binary descriptors for a basic Zephyr application. Overview ******** -A simple sample of binary descriptor definition and usage. +A simple sample of :ref:`binary descriptor ` definition and usage. Building and Running ********************