documentation refresh

.github/workflows/apps.yml

@@ -53,7 +53,7 @@ jobs:
           docker run --rm -u $(id -u):$(id -g) -w /sln_voice -v ${{github.workspace}}:/sln_voice ${XCORE_BUILDER} bash -l tools/ci/build_host_apps.sh
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.HOST_APPS_ARTIFACT_NAME }}
           path: ./dist_host
@@ -73,7 +73,7 @@ jobs:
           docker pull ${XCORE_BUILDER}
 
       - name: Download host build artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ env.HOST_APPS_ARTIFACT_NAME }}
           path: ./dist_host
@@ -93,7 +93,7 @@ jobs:
           fi
 
       - name: Save example app firmware artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.EXAMPLES_ARTIFACT_NAME }}
           path: |
@@ -115,7 +115,7 @@ jobs:
           docker pull ${XCORE_BUILDER}
 
       - name: Download host build artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ env.HOST_APPS_ARTIFACT_NAME }}
           path: ./dist_host
@@ -140,7 +140,7 @@ jobs:
           docker pull ${XCORE_BUILDER}
 
       - name: Download host build artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ${{ env.HOST_APPS_ARTIFACT_NAME }}
           path: ./dist_host

.github/workflows/ci.yml

@@ -116,7 +116,7 @@ jobs:
           zip -r --symlinks $RELEASE_SOURCES_DIR/${{ needs.event_configuration.outputs.src_artifact_name }}.zip .
 
       - name: Upload sources
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ needs.event_configuration.outputs.src_artifact_name }}
           path: ${{ env.RELEASE_SOURCES_DIR }}

CHANGELOG.rst

@@ -1,6 +1,11 @@
 XCORE-VOICE change log
 ======================
 
+2.3.1
+-----
+
+  * FIXED: Added back missing documentation.
+
 2.3.0
 -----
 

Jenkinsfile

@@ -1,4 +1,4 @@
-@Library('xmos_jenkins_shared_library@v0.34.0') _
+@Library('xmos_jenkins_shared_library@v0.38.0') _
 
 getApproval()
 
@@ -20,7 +20,7 @@ pipeline {
         )
         string(
             name: 'XMOSDOC_VERSION',
-            defaultValue: 'v6.2.0',
+            defaultValue: 'v6.3.1',
             description: 'The xmosdoc version'
         )
         booleanParam(name: 'NIGHTLY_TEST_ONLY',

doc/Doxyfile.inc

@@ -11,7 +11,7 @@ PREDEFINED += __attribute__((weak))=
 PREDEFINED += C_API= MA_C_API= C_API_START= C_API_END= EXTERN_C=
 
 # Core library APIs
-INPUT += ../modules/core/modules/xcore_math/lib_xcore_math/lib_xcore_math/api ../modules/core/modules/xcore_math/lib_xcore_math/doc/programming_guide
+INPUT += ../modules/core/modules/xcore_math/lib_xcore_math/lib_xcore_math/api ../modules/core/modules/xcore_math/lib_xcore_math/doc/rst/src/reference
 
 # Voice DSP library APIs
 INPUT += ../modules/voice/modules/lib_aec/api ../modules/voice/examples/bare-metal/shared_src/aec/
@@ -35,10 +35,7 @@ INPUT += ../modules/io/modules/i2c/api
 INPUT += ../modules/io/modules/i2s/api
 INPUT += ../modules/io/modules/spi/api
 INPUT += ../modules/io/modules/uart/api
-INPUT += ../modules/io/modules/mic_array/lib_mic_array/api ../modules/io/modules/mic_array/etc/vanilla ../modules/io/modules/mic_array/doc/programming_guide/src
-
-# QSPI library APIs
-INPUT += ../modules/lib_qspi_fast_read/lib_qspi_fast_read/api
+INPUT += ../modules/io/modules/mic_array/lib_mic_array/api ../modules/io/modules/mic_array/etc/vanilla
 
 # XCORE-VOICE APIs
 INPUT += ../modules/asr/

doc/exclude_patterns.inc

@@ -5,12 +5,12 @@ modules/core/modules/otpinfo
 modules/core/modules/random
 modules/core/modules/trycatch
 modules/rtos/modules/FreeRTOS
-modules/inferencing
 modules/io/modules/xud
 modules/io/doc/substitutions.rst
 modules/sample_rate_conversion
-modules/voice/doc/substitutions.rst
+modules/lib_qspi_fast_read
 modules/xscope_fileio
+modules/sw_pll
 modules/xua
 sln_voice_venv
 **/.venv

doc/programming_guide/asrc/resource_usage.rst

@@ -17,8 +17,7 @@ This application uses 19 chanends on the USB tile (tile 0) and 11 chanends on th
 
 The chanend use for both tiles is described in the :ref:`table-tile0-chanend-label` and :ref:`table-tile1-chanend-label` tables.
 
-Tile 0
-------
+**Tile 0**
 
 .. _table-tile0-chanend-label:
 
@@ -39,8 +38,7 @@ Tile 0
      - 1
 
 
-Tile 1
-------
+**Tile 1**
 
 .. _table-tile1-chanend-label:
 
@@ -64,13 +62,13 @@ Tile 1
 .. _intertile-context-label:
 
 Intertile contexts
-------------------
+==================
 
 The application uses 3 intertile contexts for cross tile communication.
 
-    * A dedicated intertile context for sending ASRC output data from the |I2S| tile to the USB tile.
-    * A dedicated intertile context for sending ASRC output data from the USB tile to the |I2S| tile.
-    * The intertile context for all other cross tile communication.
+* A dedicated intertile context for sending ASRC output data from the |I2S| tile to the USB tile.
+* A dedicated intertile context for sending ASRC output data from the USB tile to the |I2S| tile.
+* The intertile context for all other cross tile communication.
 
 
 CPU
@@ -80,8 +78,7 @@ Profiling the CPU usage for this application using an RTOS friendly profiling to
 However, profiling some application tasks has taken place. These numbers along with some already existing profiling numbers for the drivers are listed in the :ref:`table-mips-tile0-label` and :ref:`table-mips-tile1-label` tables.
 Each tile has 5 bare-metal cores being used for running RTOS tasks so each core has a fixed bandwidth of 120 MHz available.
 
-Tile 0
-------
+**Tile 0**
 
 .. _table-mips-tile0-label:
 
@@ -102,8 +99,7 @@ Tile 0
      - 14
 
 
-Tile 1
-------
+**Tile 1**
 
 .. _table-mips-tile1-label:
 

doc/programming_guide/ffd/speech_recognition_cyberon.rst

@@ -19,8 +19,7 @@ The Cyberon DSpotter™ speech recognition engine runs proprietary models to ide
 
 One model for US English is provided. For any technical questions or additional models please contact Cyberon.
 
-.. TODO: Check if the line below can be removed or re-added
-.. To replace the Cyberon engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
+To replace the Cyberon engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
 
 Dictionary command table
 ========================

doc/programming_guide/ffd/speech_recognition_sensory.rst

@@ -26,8 +26,7 @@ Two models are provided - one in US English and one in Mainland Mandarin. The US
     make clean
     make flash_app_example_ffd_sensory -j
 
-.. TODO: Check if the line below can be removed or re-added
-.. To replace the Sensory engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
+To replace the Sensory engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
 
 Dictionary command table
 ========================

doc/programming_guide/index.rst

@@ -11,6 +11,7 @@ XCORE-VOICE Programming Guide
    prerequisites
    example_designs
    asr_ports
+   asr/asr
    extending
    howto
    faq

doc/programming_guide/low_power_ffd/speech_recognition.rst

@@ -43,8 +43,7 @@ Make sure run the following commands to rebuild and re-flash the data partition:
 
 You may also wish to modify the command ID-to-string lookup table which is located in the ``src/intent_engine/intent_engine_io.c`` source file.
 
-.. TODO: Check if the line below can be removed or re-added
-.. To replace the Sensory engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
+To replace the Sensory engine with a different engine, refer to the ASR documentation on :ref:`sln_voice_asr_programming_guide`
 
 Wake Word Dictionary
 ====================

index.rst

@@ -13,8 +13,8 @@ XCORE |reg| -VOICE Solutions
   modules/rtos/doc/programming_guide/index
   modules/rtos/doc/build_system_guide/index
   modules/io/doc/programming_guide/index
-  modules/io/modules/mic_array/doc/programming_guide/index.rst
-  modules/core/modules/xcore_math/lib_xcore_math/doc/programming_guide/index.rst
+  modules/io/modules/mic_array/doc/rst/lib_mic_array
+  modules/core/modules/xcore_math/lib_xcore_math/doc/rst/lib_xcore_math
 
 .. only:: html
 

settings.yml

@@ -1,7 +1,7 @@
 ---
 project: sln_voice
 title: XCORE-VOICE SOLUTION
-version: 2.3.0
+version: 2.3.1
 
 documentation:
   exclude_patterns_path: doc/exclude_patterns.inc