michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fs: samples: Use new Sphinx extension to document samples

Browse source 
Use the new code-sample directive and roles to document the filesystem
samples so that they show up as "Related samples" when browsing the API
documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-09-06 19:51:25 +02:00 • committed by Carles Cufí
commit 30cd9a22cf
5 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

7
samples/subsys/fs/format/README.rst
View file

@ -1,7 +1,8 @@
.. _fs_format_sample: .. zephyr:code-sample:: fs-format
:name: Formatting
:relevant-api: file_system_api
FS Format Sample Format different storage devices for different file systems.
################
Overview Overview
*********** ***********

7
samples/subsys/fs/fs_sample/README.rst
View file

@ -1,7 +1,8 @@
.. _fs_sample: .. zephyr:code-sample:: fs
:name: Filesystem manipulation
:relevant-api: file_system_api disk_access_interface
Filesystems Sample Application Use filesystem API with various filesystems and storage devices.
###################################
Overview Overview
******** ********

7
samples/subsys/fs/littlefs/README.rst
View file

@ -1,7 +1,8 @@
.. _littlefs-sample: .. zephyr:code-sample:: littlefs
:name: LittleFS filesystem
:relevant-api: file_system_api flash_area_api
littlefs File System Sample Application Use file system API over LittleFS.
#######################################
Overview Overview
******** ********

2
samples/subsys/shell/fs/README.rst
View file

@ -48,7 +48,7 @@ Particle Xenon
============== ==============
This target is customized to support the same SPI NOR partition table as This target is customized to support the same SPI NOR partition table as
the :ref:`littlefs-sample`. the :zephyr:code-sample:`littlefs` sample.
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/subsys/shell/fs :zephyr-app: samples/subsys/shell/fs

2
samples/subsys/usb/mass/README.rst
View file

@ -157,7 +157,7 @@ LittleFS Example
This board configures to use the external 64 MiBi QSPI flash chip with a This board configures to use the external 64 MiBi QSPI flash chip with a
128 KiBy `littlefs`_ partition compatible with the one produced by the 128 KiBy `littlefs`_ partition compatible with the one produced by the
:ref:`littlefs-sample`. :zephyr:code-sample:`littlefs` sample.
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/subsys/usb/mass :zephyr-app: samples/subsys/usb/mass