doc: further restructure

annwoj · annwoj · commit 3f69cef2019d · 2026-02-05T11:47:49.000+01:00
cleans up samples and other structure

Signed-off-by: Anna Wojdylo &lt;anna.wojdylo@nordicsemi.no&gt;
diff --git a/doc/conf.py b/doc/conf.py
@@ -34,11 +34,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'nRF Connect SDK - Edge AI Add-on'
-copyright = '2025, Nordic Semiconductor'
+copyright = '2026, Nordic Semiconductor'
 author = 'Nordic Semiconductor'
 
 # The full version, including alpha/beta/rc tags
-release = '2025'
+release = '2026'
 
 
 # -- General configuration ---------------------------------------------------
@@ -66,8 +66,6 @@
 
 external_content_contents = [
     (EDGE_AI_BASE / "doc", "[!_]*"),
-    (EDGE_AI_BASE, "applications/**/*.rst"),
-    (EDGE_AI_BASE, "samples/**/*.rst"),
 ]
 
 # Options for table_from_rows --------------------------------------------------
diff --git a/doc/images/ei_data_acquisition.png b/doc/images/ei_data_acquisition.png
diff --git a/doc/images/ei_start_sampling.png b/doc/images/ei_start_sampling.png
diff --git a/doc/index.rst b/doc/index.rst
@@ -47,7 +47,6 @@ See the following documentation:
    setting_up_environment.rst
    applications.rst
    samples.rst
-   tests.rst
    integrations.rst
    drivers.rst
    axon_compiler.rst
diff --git a/doc/integrations/edge_impulse.rst b/doc/integrations/edge_impulse.rst
@@ -25,7 +25,7 @@ Integration overview
 Before integrating the Edge Impulse machine learning model into an |EAI| application, you must prepare and deploy the machine learning model for your embedded device.
 This model is prepared using the `Edge Impulse studio`_ external web tool.
 It relies on sensor data that can be provided by different sources, for example data forwarder.
-Check the :ref:`ei_data_forwarder_sample` sample for a demonstration of how you can send sensor data to Edge Impulse studio using `Edge Impulse's data forwarder`_.
+Check the :ref:`include_ei_data_forwarder_sample` sample for a demonstration of how you can send sensor data to Edge Impulse studio using `Edge Impulse's data forwarder`_.
 
 The machine learning model is distributed as a single :file:`zip` archive that includes C++ library sources.
 This file is used by the |NCS| build system to build the Edge Impulse library.
@@ -53,7 +53,7 @@ This tutorial will guide you through the following steps:
 
    .. note::
      You can use one of the development boards supported directly by Edge Impulse or your mobile phone to collect the data.
-     You can also modify the :ref:`ei_data_forwarder_sample` application and use it to forward data from a sensor that is connected to any board available in the |NCS|.
+     You can also modify the :ref:`include_ei_data_forwarder_sample` application and use it to forward data from a sensor that is connected to any board available in the |NCS|.
 
 #. Designing your machine learning model (an *impulse*).
 #. Deploying the machine learning model to use it on an embedded device.
@@ -87,4 +87,4 @@ Applications and samples
 
 The following samples demonstrate the Edge Impulse integration in the |EAI|:
 
-* :ref:`ei_data_forwarder_sample` sample - demonstrates how you can send sensor data to Edge Impulse studio using `Edge Impulse's data forwarder`_.
+* :ref:`include_ei_data_forwarder_sample` sample - demonstrates how you can send sensor data to Edge Impulse studio using `Edge Impulse's data forwarder`_.
diff --git a/doc/release_notes_and_migration/release_notes_v100.rst b/doc/release_notes_and_migration/release_notes_v100.rst
@@ -24,9 +24,9 @@ This release is based on the |NCS| release v3.2.0.
   * Support for Cortex-M4 and Cortex-M33 architectures with precompiled libraries.
   * Three reference samples:
 
-    * :ref:`Classification <runtime_classification_sample>`
-    * :ref:`Regression <runtime_regression_sample>`
-    * :ref:`Anomaly detection <runtime_anomaly_sample>`
+    * :ref:`Classification <include_runtime_classification_sample>`
+    * :ref:`Regression <include_runtime_regression_sample>`
+    * :ref:`Anomaly detection <include_runtime_anomaly_sample>`
 
   * Comprehensive documentation, including :ref:`integration <integrations>` guide, :ref:`library API references<libraries>`, and :ref:`samples overview <samples_nrf_edge_ai>`.
   * Kconfig options for enabling and configuring the library.
diff --git a/doc/samples.rst b/doc/samples.rst
@@ -1,7 +1,8 @@
 .. _samples_nrf_edge_ai:
+.. _tests:
 
-Samples
-#######
+Samples and tests
+#################
 
 .. contents::
    :local:
@@ -12,9 +13,6 @@ You can build the samples for a variety of board targets and configure them for
 
 In the |EAI| repository, all samples are placed in the :file:`samples` directory.
 
-Overview
-********
-
 The samples demonstrate typical workflows using the nRF Edge AI components such as digital signal processing (DSP) primitives, neural network engines, and runtime for the models generated by `Nordic Edge AI Lab`_.
 
 * Runtime - Demonstrates using the nRF Edge AI runtime to initialize a model and run inference with a `Nordic Edge AI Lab`_ generated model.
diff --git a/doc/samples/axon.rst b/doc/samples/axon.rst
@@ -1,12 +1,21 @@
 .. _axon_samples:
 
-Axon NPU samples
-################
+Axon NPU samples and tests
+##########################
+
+This section lists the available samples and tests that demonstrate the use of the |EAI| with the Axon NPU driver.
+
+The samples cover neural network inference, DSP‑style algorithms for feature extraction, and combined use cases that integrate both approaches.
+
+Each sample can be built either for a Zephyr‑based target or for the Axon simulator. 
+The simulator is not a standalone tool or dedicated hardware. 
+Instead, it is provided as a static library that is linked into a host‑based console application. 
+While it is not cycle‑accurate compared to hardware, it is computationally bit‑exact and can be used to estimate performance.
 
-This section lists the available samples that demonstrate the use of the |EAI| with the Axon NPU driver.
 
 .. toctree::
    :maxdepth: 1
    :caption: Subpages
 
    /../samples/axon/hello_axon/README.rst
+   /../samples/axon/test_nn_inference/README.rst
diff --git a/doc/samples/axon/hello_axon/README.rst b/doc/samples/axon/hello_axon/README.rst
@@ -0,0 +1,19 @@
+﻿.. _include_sample_hello_axon:
+
+Hello Axon
+##########
+
+.. include:: ../../../../samples/axon/hello_axon/README.rst
+   :start-after: ##########
+   :end-before: Configuration options
+
+Configuration options
+=====================
+
+|sample_kconfig|
+
+.. options-from-kconfig::
+   :show-type:
+
+.. include:: ../../../../samples/axon/hello_axon/README.rst
+   :start-after: :show-type:
diff --git a/doc/samples/axon/test_nn_inference/README.rst b/doc/samples/axon/test_nn_inference/README.rst
@@ -0,0 +1,7 @@
+.. _test_nn_inference:
+
+Test: NN Inference
+##################
+
+.. include:: ../../../../tests/axon/inference/README.rst
+   :start-after: ##################
diff --git a/doc/samples/edge_impulse/data_forwarder/README.rst b/doc/samples/edge_impulse/data_forwarder/README.rst
@@ -0,0 +1,7 @@
+﻿.. _include_ei_data_forwarder_sample:
+
+Edge Impulse: Data forwarder
+############################
+
+.. include:: ../../../../samples/edge_impulse/data_forwarder/README.rst
+   :start-after: ############################
diff --git a/doc/samples/nrf_edgeai/anomaly/README.rst b/doc/samples/nrf_edgeai/anomaly/README.rst
@@ -0,0 +1,7 @@
+﻿.. _include_runtime_anomaly_sample:
+
+Anomaly detection sample
+########################
+
+.. include:: ../../../../samples/nrf_edgeai/anomaly/README.rst
+   :start-after: ########################
diff --git a/doc/samples/nrf_edgeai/classification/README.rst b/doc/samples/nrf_edgeai/classification/README.rst
@@ -0,0 +1,7 @@
+﻿.. _include_runtime_classification_sample:
+
+Classification sample
+#####################
+
+.. include:: ../../../../samples/nrf_edgeai/classification/README.rst
+   :start-after: #####################
diff --git a/doc/samples/nrf_edgeai/regression/README.rst b/doc/samples/nrf_edgeai/regression/README.rst
@@ -0,0 +1,7 @@
+﻿.. _include_runtime_regression_sample:
+
+Regression sample
+#################
+
+.. include:: ../../../../samples/nrf_edgeai/regression/README.rst
+   :start-after: #################
diff --git a/doc/tests.rst b/doc/tests.rst
diff --git a/doc/tests/axon_npu_samples.rst b/doc/tests/axon_npu_samples.rst
diff --git a/samples/edge_impulse/data_forwarder/README.rst b/samples/edge_impulse/data_forwarder/README.rst
@@ -96,17 +96,17 @@ Testing
    a. Go to the :guilabel:`Data acquisition` tab.
    #. In the **Collect data** panel, set the desired values and click :guilabel:`Start sampling`.
 
-      .. figure:: ./doc/images/ei_data_acquisition.png
-         :scale: 50 %
+      .. figure:: /images/ei_data_acquisition.png
+         :scale: 80 %
          :alt: Sampling under Data acquisition in Edge Impulse studio
 
          Sampling under Data acquisition in Edge Impulse studio
 
    #. Observe the received sample data on the raw data graph under the panel.
       For the default sample configuration, you should observe sine waves.
 
-      .. figure:: ./doc/images/ei_start_sampling.png
-         :scale: 50 %
+      .. figure:: /images/ei_data_acquisition.png
+         :scale: 80 %
          :alt: Sampling example
 
          Sampling example
diff --git a/tests/axon/inference/README.rst b/tests/axon/inference/README.rst
@@ -1,7 +1,7 @@
 .. _test_nn_inference:
 
-Test NN Inference
-#################
+Test: NN Inference
+##################
 
 .. contents::
    :local:
