Commit Graph

5 Commits

Author SHA1 Message Date
Benjamin Cabé 1db9b009a7 doc: samples: Adopt code-sample-category across tree
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
Benjamin Cabé 25fa25a5a9 doc: :zephyr-app: should point to existing in-tree folders
As there is no check (yet!) in the directive, many
.. zephyr-app-commands:: in the documentation are pointing to
non-existing sample applications, which is problematic for users who
typically expect to just copy-paste the commands and have them work.

This commit fixes all offending references to point to existing samples,
or converts them to simple ":app:" instead of ":zephyr-app:" when the
intent wasn't to refer to in-tree samples.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-09 13:53:47 -04:00
Benjamin Cabé f6c232ec2e samples: modules: use zephyr:code-sample directive
Describe the samples using code-sample directive in preparation for
upcoming changes to the Zephyr documentation that will be leveraging
the provided description and metadata.

Also fixed a couple invalid or missing table of contents to have
proper document hierarchy.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-02 11:51:37 +02:00
Parthiban Nallathambi f8c51d70c4 samples: add steps to add lz4 into west manifest
lz4 is moved as optional module, add step in README to add
as project filter to include into west manifest.

Fixes: https://github.com/zephyrproject-rtos/zephyr/issues/65127

Signed-off-by: Parthiban Nallathambi <parthiban@linumiz.com>
2024-08-12 19:24:15 -04:00
Parthiban Nallathambi a65096fc37 samples: move lz4 into modules
all the external modules related samples are part of samples/modules,
whereas lz4 is in parent. move it to sample/modules/compression/lz4

Signed-off-by: Parthiban Nallathambi <parthiban@linumiz.com>
2024-08-12 19:24:15 -04:00