Docs: Platform documentation rules
- Minimal rules for a platform documentation
- Adjust existing platforms according to the rules
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: Idcb85f8ed5d55aa6406cd48cdfcb558d92ff0647
diff --git a/docs/platform/arm/index.rst b/docs/platform/arm/index.rst
index 68eb5c5..4bb36c4 100755
--- a/docs/platform/arm/index.rst
+++ b/docs/platform/arm/index.rst
@@ -3,7 +3,7 @@
#############
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
:titlesonly:
Corstone-1000 <corstone1000/readme.rst>
diff --git a/docs/platform/cypress/index.rst b/docs/platform/cypress/index.rst
new file mode 100644
index 0000000..b3305a6
--- /dev/null
+++ b/docs/platform/cypress/index.rst
@@ -0,0 +1,9 @@
+################
+Cypress platform
+################
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ PSoC64 <psoc64/index.rst>
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
index 4c53ebb..871395b 100644
--- a/docs/platform/index.rst
+++ b/docs/platform/index.rst
@@ -4,52 +4,15 @@
.. toctree::
:maxdepth: 2
- :caption: arm
- arm/index
-
-.. toctree::
- :maxdepth: 1
- :caption: NXP
- :glob:
-
- nxp/**
-
-.. toctree::
- :maxdepth: 1
- :caption: Cypress
- :glob:
-
- cypress/psoc64/index
-
-.. toctree::
- :maxdepth: 2
- :caption: STM
- :glob:
-
- stm/index
-
-.. toctree::
- :maxdepth: 1
- :caption: Nordic
- :glob:
-
- nordic_nrf/**
-
-.. toctree::
- :maxdepth: 1
- :caption: Laird Connectivity
- :glob:
-
- lairdconnectivity/**
-
-.. toctree::
- :maxdepth: 1
- :caption: Nuvoton
- :glob:
-
- nuvoton/**
+ Arm <arm/index>
+ Cypress <cypress/index>
+ Laird Connectivity <lairdconnectivity/index>
+ Nordic <nordic_nrf/index>
+ Nuvoton <nuvoton/index>
+ NXP <nxp/index>
+ STMICROELECTRONICS <stm/index>
--------------
-*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2020-2023, Arm Limited. All rights reserved.*
diff --git a/docs/platform/lairdconnectivity/index.rst b/docs/platform/lairdconnectivity/index.rst
new file mode 100644
index 0000000..cb52760
--- /dev/null
+++ b/docs/platform/lairdconnectivity/index.rst
@@ -0,0 +1,9 @@
+###########################
+Laird Connectivity platform
+###########################
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ BL5340 <bl5340_dvk_cpuapp/README.rst>
diff --git a/docs/platform/nordic_nrf/index.rst b/docs/platform/nordic_nrf/index.rst
new file mode 100644
index 0000000..17c4f29
--- /dev/null
+++ b/docs/platform/nordic_nrf/index.rst
@@ -0,0 +1,10 @@
+################
+Nordic platforms
+################
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ nRF5340 <nrf5340dk_nrf5340_cpuapp/README.rst>
+ nRF9160 <nrf9160dk_nrf9160/README.rst>
diff --git a/docs/platform/nuvoton/index.rst b/docs/platform/nuvoton/index.rst
new file mode 100644
index 0000000..b59e748
--- /dev/null
+++ b/docs/platform/nuvoton/index.rst
@@ -0,0 +1,10 @@
+#################
+Nuvoton platforms
+#################
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ NuMaker-PFM-M2351 <m2351/README.rst>
+ NuMaker-PFM-M2354 <m2354/README.rst>
diff --git a/docs/platform/nxp/index.rst b/docs/platform/nxp/index.rst
new file mode 100644
index 0000000..0ed452c
--- /dev/null
+++ b/docs/platform/nxp/index.rst
@@ -0,0 +1,9 @@
+############
+NXP platform
+############
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ LPCXpresso55S69 <lpcxpresso55s69/README.rst>