From d7e031c4d3092aab13b3f62fb6bd3a0d02cdd573 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 6 Sep 2024 16:07:48 +0200 Subject: [PATCH] samples: doc: clean-up table of contents for board samples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Board samples were listed in a very flat way before. This commit introduces the appropriate toctrees to fix this. Signed-off-by: Benjamin Cabé --- samples/boards/96boards/argonkey/index.rst | 10 ++++++++++ samples/boards/96boards/index.rst | 10 ++++++++++ samples/boards/bbc/index.rst | 11 +++++++++++ samples/boards/boards.rst | 5 +++-- samples/boards/enjoydigital/index.rst | 10 ++++++++++ samples/boards/espressif/index.rst | 10 ++++++++++ samples/boards/google/index.rst | 10 ++++++++++ samples/boards/intel/index.rst | 10 ++++++++++ samples/boards/microchip/index.rst | 10 ++++++++++ samples/boards/nordic/index.rst | 10 ++++++++++ samples/boards/nxp/index.rst | 10 ++++++++++ samples/boards/phytec/index.rst | 10 ++++++++++ samples/boards/quicklogic/index.rst | 10 ++++++++++ samples/boards/st/index.rst | 10 ++++++++++ samples/boards/ti/index.rst | 10 ++++++++++ 15 files changed, 144 insertions(+), 2 deletions(-) create mode 100644 samples/boards/96boards/argonkey/index.rst create mode 100644 samples/boards/96boards/index.rst create mode 100644 samples/boards/bbc/index.rst create mode 100644 samples/boards/enjoydigital/index.rst create mode 100644 samples/boards/espressif/index.rst create mode 100644 samples/boards/google/index.rst create mode 100644 samples/boards/intel/index.rst create mode 100644 samples/boards/microchip/index.rst create mode 100644 samples/boards/nordic/index.rst create mode 100644 samples/boards/nxp/index.rst create mode 100644 samples/boards/phytec/index.rst create mode 100644 samples/boards/quicklogic/index.rst create mode 100644 samples/boards/st/index.rst create mode 100644 samples/boards/ti/index.rst diff --git a/samples/boards/96boards/argonkey/index.rst b/samples/boards/96boards/argonkey/index.rst new file mode 100644 index 00000000000..2713379253d --- /dev/null +++ b/samples/boards/96boards/argonkey/index.rst @@ -0,0 +1,10 @@ +.. _argonkey-samples: + +Argonkey Samples +################ + +.. toctree:: + :maxdepth: 1 + :glob: + + */* diff --git a/samples/boards/96boards/index.rst b/samples/boards/96boards/index.rst new file mode 100644 index 00000000000..0a024b7cf27 --- /dev/null +++ b/samples/boards/96boards/index.rst @@ -0,0 +1,10 @@ +.. _96boards_samples: + +96Boards +======== + +.. toctree:: + :titlesonly: + :glob: + + */* diff --git a/samples/boards/bbc/index.rst b/samples/boards/bbc/index.rst new file mode 100644 index 00000000000..73d1dc1adba --- /dev/null +++ b/samples/boards/bbc/index.rst @@ -0,0 +1,11 @@ +.. _bbc_samples: + +BBC +=== + +.. toctree:: + :titlesonly: + :maxdepth: 1 + :glob: + + */* diff --git a/samples/boards/boards.rst b/samples/boards/boards.rst index 146a59fe087..c5433a6a9fe 100644 --- a/samples/boards/boards.rst +++ b/samples/boards/boards.rst @@ -4,7 +4,8 @@ Board-specific samples ###################### .. toctree:: - :maxdepth: 1 + :titlesonly: + :maxdepth: 2 :glob: - **/* + */* diff --git a/samples/boards/enjoydigital/index.rst b/samples/boards/enjoydigital/index.rst new file mode 100644 index 00000000000..9b75eca52e1 --- /dev/null +++ b/samples/boards/enjoydigital/index.rst @@ -0,0 +1,10 @@ +.. _enjoydigital_samples: + +EnjoyDigital +============ + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/espressif/index.rst b/samples/boards/espressif/index.rst new file mode 100644 index 00000000000..525e8e831a9 --- /dev/null +++ b/samples/boards/espressif/index.rst @@ -0,0 +1,10 @@ +.. _espressif_samples: + +Espressif +========= + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/google/index.rst b/samples/boards/google/index.rst new file mode 100644 index 00000000000..ba16924e063 --- /dev/null +++ b/samples/boards/google/index.rst @@ -0,0 +1,10 @@ +.. _google_samples: + +Google +====== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/intel/index.rst b/samples/boards/intel/index.rst new file mode 100644 index 00000000000..737134a5529 --- /dev/null +++ b/samples/boards/intel/index.rst @@ -0,0 +1,10 @@ +.. _intel_samples: + +Intel +===== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/microchip/index.rst b/samples/boards/microchip/index.rst new file mode 100644 index 00000000000..85e4926721e --- /dev/null +++ b/samples/boards/microchip/index.rst @@ -0,0 +1,10 @@ +.. _microchip_samples: + +Microchip +========= + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/nordic/index.rst b/samples/boards/nordic/index.rst new file mode 100644 index 00000000000..01d44950439 --- /dev/null +++ b/samples/boards/nordic/index.rst @@ -0,0 +1,10 @@ +.. _nordic_samples: + +Nordic Semiconductor +==================== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/nxp/index.rst b/samples/boards/nxp/index.rst new file mode 100644 index 00000000000..318bc81e0bb --- /dev/null +++ b/samples/boards/nxp/index.rst @@ -0,0 +1,10 @@ +.. _nxp_samples: + +NXP +=== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/phytec/index.rst b/samples/boards/phytec/index.rst new file mode 100644 index 00000000000..81f1d5f2f38 --- /dev/null +++ b/samples/boards/phytec/index.rst @@ -0,0 +1,10 @@ +.. _phytec_samples: + +PHYTEC +====== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/quicklogic/index.rst b/samples/boards/quicklogic/index.rst new file mode 100644 index 00000000000..9de957464e2 --- /dev/null +++ b/samples/boards/quicklogic/index.rst @@ -0,0 +1,10 @@ +.. _quicklogic_samples: + +QuickLogic Corp. +================ + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/st/index.rst b/samples/boards/st/index.rst new file mode 100644 index 00000000000..06ccf192ab6 --- /dev/null +++ b/samples/boards/st/index.rst @@ -0,0 +1,10 @@ +.. _st_samples: + +STMicroelectronics +================== + +.. toctree:: + :titlesonly: + :glob: + + **/* diff --git a/samples/boards/ti/index.rst b/samples/boards/ti/index.rst new file mode 100644 index 00000000000..ad970714f40 --- /dev/null +++ b/samples/boards/ti/index.rst @@ -0,0 +1,10 @@ +.. _ti_samples: + +Texas Instruments +================= + +.. toctree:: + :titlesonly: + :glob: + + **/*