doc: tools: add tools section and pages

Added tools section and pages in documentation. This adds readmies for chip-cert and spake2p to the doc pool. Signed-off-by: Grzegorz Ferenc <[email protected]>
project-chip · Apr 27, 2023 · aced677 · aced677
1 parent c2a28c8
commit aced677
Show file tree

Hide file tree

Showing 6 changed files with 66 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -69,6 +69,7 @@
     (MATTER_BASE, "examples/**/*.png"),
     (MATTER_BASE, "examples/**/*.jpg"),
     (MATTER_BASE, "examples/**/*.JPG"),
+    (MATTER_BASE, "tools/**/*.md"),
 ]
 external_content_link_prefixes = [
     "src/",

diff --git a/docs/index.md b/docs/index.md
@@ -13,6 +13,7 @@ discussion/index
 guides/index
 style/index
 examples/index
+tools/index
 BUG_REPORT
 code_generation
 ERROR_CODES

diff --git a/docs/tools/index.md b/docs/tools/index.md
@@ -0,0 +1,61 @@
+# Tools
+
+The Matter SDK provides tools that allow you to generate and manage different aspects of the Matter development.
+
+## C++ tools
+
+Source files for these tools are located at `src/tools`.
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+chip-cert/README
+spake2p/README
+```
+
+## Python tools
+
+Source files for these tools are located at `scripts/tools`.
+
+### General tools
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+tools/memory/README
+tools/spake2p/README
+
+```
+
+### NXP tools
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+tools/nxp/factory_data_generator/README
+tools/nxp/ota/README
+
+```
+
+### Silabs tools
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+tools/silabs/README
+
+```
+
+### Telink tools
+
+```{toctree}
+:glob:
+:maxdepth: 1
+
+tools/telink/readme
+
+```
diff --git a/scripts/tools/nxp/factory_data_generator/README.md b/scripts/tools/nxp/factory_data_generator/README.md
@@ -1,4 +1,4 @@
-## NXP Factory Data Generator
+# NXP Factory Data Generator
 
 For usage of the tool, please see
 [Guide for writing manufacturing data on NXP devices](../../../../examples/platform/nxp/doc/manufacturing_flow.md).

diff --git a/scripts/tools/silabs/README.md b/scripts/tools/silabs/README.md
@@ -1,4 +1,4 @@
-#`FactoryDataProvider` for EFR32 Matter device
+# `FactoryDataProvider` for EFR32 Matter device
 
 ## Introduction
 

diff --git a/src/tools/chip-cert/README.md b/src/tools/chip-cert/README.md
@@ -809,7 +809,7 @@ HELP OPTIONS
        Print the version and then exit.
 ```
 
-#### gen-cd example
+#### print-cd example
 
 An example of printing a Certificate Declaration (CD), which is provided as a
 command line argument in a hex format: