tests: reorganize the docs/tests folders and add index for each module.

Signed-off-by: AlexandraTrifan <[email protected]>
analogdevicesinc · Feb 3, 2025 · 15b5a6b · 15b5a6b
1 parent 59ed5f1
commit 15b5a6b
Show file tree

Hide file tree

Showing 13 changed files with 112 additions and 23 deletions.
diff --git a/docs/tests/plugins/adc/index.rst b/docs/tests/plugins/adc/index.rst
@@ -0,0 +1,13 @@
+.. _tests_adc:
+
+ADC
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   adc_tests
diff --git a/docs/tests/plugins/dac/index.rst b/docs/tests/plugins/dac/index.rst
@@ -0,0 +1,13 @@
+.. _tests_dac:
+
+DAC
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   dac_tests
diff --git a/docs/tests/plugins/datalogger/index.rst b/docs/tests/plugins/datalogger/index.rst
@@ -0,0 +1,13 @@
+.. _tests_datalogger:
+
+Datalogger
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   datalogger_tests
diff --git a/docs/tests/plugins/debugger/index.rst b/docs/tests/plugins/debugger/index.rst
@@ -1,6 +1,6 @@
 .. _tests_debugger:
 
-Debugger Test Cases
+Debugger
 ===============================================================================
 
 Contents

diff --git a/docs/tests/plugins/index.rst b/docs/tests/plugins/index.rst
@@ -13,24 +13,13 @@ Contents
    :includehidden:
    :maxdepth: 3
 
-   pqm/pqm_tests
-   datalogger/datalogger_tests
-   dac/dac_tests
-   swiot1l/swiot1l_tests
-   adc/adc_tests
-
-   m2k/digital_io_tests
-   m2k/logic_analyzer_tests
-   m2k/power_supply_tests
-   m2k/oscilloscope_tests
-   m2k/network_analyzer_tests
-   m2k/general_settings_tests
-   m2k/spectrum_analyzer_tests
-   m2k/signal_generator_tests
-   m2k/pattern_generator_tests
-   m2k/voltmeter_tests
-
-   registermap/registermap_tests
+   pqm/index
+   datalogger/index
+   dac/index
+   swiot1l/index
+   adc/index
+   m2k/index
+   registermap/index
    debugger/index
 
 ..

diff --git a/docs/tests/plugins/m2k/index.rst b/docs/tests/plugins/m2k/index.rst
@@ -0,0 +1,22 @@
+.. _tests_m2k:
+
+ADALM2000
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   digital_io_tests
+   general_settings_tests
+   logic_analyzer_tests
+   network_analyzer_tests
+   oscilloscope_tests
+   pattern_generator_tests
+   power_supply_tests
+   spectrum_analyzer_tests
+   signal_generator_tests
+   voltmeter_tests
diff --git a/docs/tests/plugins/m2k/pattern_generator_tests.rst b/docs/tests/plugins/m2k/pattern_generator_tests.rst
@@ -1,6 +1,6 @@
 .. _m2k_pattern_generator_tests:
 
-M2K Pattern Generator - Test Suite
+Pattern Generator - Test Suite
 ====================================================================================================
 
 .. note::

diff --git a/docs/tests/plugins/m2k/signal_generator_tests.rst b/docs/tests/plugins/m2k/signal_generator_tests.rst
@@ -1,6 +1,6 @@
 .. _m2k_signal_generator_tests:
 
-M2K Signal Generator - Test Suite
+Signal Generator - Test Suite
 =======================================================
 
 .. note::

diff --git a/docs/tests/plugins/m2k/spectrum_analyzer_tests.rst b/docs/tests/plugins/m2k/spectrum_analyzer_tests.rst
@@ -1,6 +1,6 @@
 .. _m2k_spectrum_analyzer_tests:
 
-M2K Spectrum Analyzer - Test Suite
+Spectrum Analyzer - Test Suite
 ====================================================================================================
 
 .. note::

diff --git a/docs/tests/plugins/m2k/voltmeter_tests.rst b/docs/tests/plugins/m2k/voltmeter_tests.rst
@@ -1,6 +1,6 @@
 .. _m2k_voltmeter_tests:
 
-M2K Voltmeter - Test Suite
+Voltmeter - Test Suite
 ===============================================================================
 
 .. note::

diff --git a/docs/tests/plugins/pqm/index.rst b/docs/tests/plugins/pqm/index.rst
@@ -0,0 +1,13 @@
+.. _tests_pqm:
+
+PQM
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   pqm_tests
diff --git a/docs/tests/plugins/registermap/index.rst b/docs/tests/plugins/registermap/index.rst
@@ -0,0 +1,13 @@
+.. _tests_registermap:
+
+Register Map
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   registermap_tests
diff --git a/docs/tests/plugins/swiot1l/index.rst b/docs/tests/plugins/swiot1l/index.rst
@@ -0,0 +1,13 @@
+.. _tests_swiot1l:
+
+SWIOT1L
+===============================================================================
+
+Contents
+---------------------------------------------------------------------
+
+.. toctree::
+   :includehidden:
+   :maxdepth: 3
+
+   swiot1l_tests