Skip to content

Commit

Permalink
samples: doc: clean-up table of contents for board samples
Browse files Browse the repository at this point in the history
Board samples were listed in a very flat way before.
This commit introduces the appropriate toctrees to fix this.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
  • Loading branch information
kartben committed Sep 12, 2024
1 parent 851c41b commit 46f81d5
Show file tree
Hide file tree
Showing 15 changed files with 144 additions and 2 deletions.
10 changes: 10 additions & 0 deletions samples/boards/96boards/argonkey/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _argonkey-samples:

Argonkey Samples
################

.. toctree::
:maxdepth: 1
:glob:

*/*
10 changes: 10 additions & 0 deletions samples/boards/96boards/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _96boards_samples:

96Boards
========

.. toctree::
:titlesonly:
:glob:

*/*
11 changes: 11 additions & 0 deletions samples/boards/bbc/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _bbc_samples:

BBC
===

.. toctree::
:titlesonly:
:maxdepth: 1
:glob:

*/*
5 changes: 3 additions & 2 deletions samples/boards/boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Board-specific samples
######################

.. toctree::
:maxdepth: 1
:titlesonly:
:maxdepth: 2
:glob:

**/*
*/*
10 changes: 10 additions & 0 deletions samples/boards/enjoydigital/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _enjoydigital_samples:

EnjoyDigital
============

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/espressif/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _espressif_samples:

Espressif
=========

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/google/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _google_samples:

Google
======

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/intel/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _intel_samples:

Intel
=====

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/microchip/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _microchip_samples:

Microchip
=========

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/nordic/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _nordic_samples:

Nordic Semiconductor
====================

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/nxp/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _nxp_samples:

NXP
===

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/phytec/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _phytec_samples:

PHYTEC
======

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/quicklogic/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _quicklogic_samples:

QuickLogic Corp.
================

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/st/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _st_samples:

STMicroelectronics
==================

.. toctree::
:titlesonly:
:glob:

**/*
10 changes: 10 additions & 0 deletions samples/boards/ti/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _ti_samples:

Texas Instruments
=================

.. toctree::
:titlesonly:
:glob:

**/*

0 comments on commit 46f81d5

Please sign in to comment.