Documentation update

.github/workflows/deploy-docs.yml

@@ -0,0 +1,46 @@
+name: Deploy docs to Cloudflare
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    name: Deploy to Cloudflare Pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install OS dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -qq doxygen graphviz
+          cd ${{ github.workspace }}
+          sudo ./install_dependencies.sh
+
+      - name: Set up Python venv
+        uses: actions/setup-python@v5
+        with: { python-version: "3.13" }
+
+      - name: Install Python dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Generate documentation
+        run: |
+          cd ${{ github.workspace }}/docs
+          ./generate_docs.sh rebuild
+
+      - name: Deploy to Cloudflare Worker
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CF_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT }}
+          wranglerVersion: "4"
+          command: ${{ github.event_name == 'pull_request' && 'versions upload' || 'deploy' }}

.gitignore

@@ -10,6 +10,7 @@ venv/
 __pycache__
 node_modules/
 package-lock.json
+.wrangler
 
 # Sphinx
 _build

CMakeLists.txt

@@ -296,7 +296,7 @@ endif()
 option(BUILD_DOCS "Generate documentation" ON)
 add_feature_info("BUILD_DOCS" BUILD_DOCS "Build documentation")
 if(BUILD_DOCS)
-    add_subdirectory(docs/developer/doxygen)
+    add_subdirectory(docs/developer/)
 endif()
 
 #########################################################################

docs/conf.py

@@ -70,7 +70,7 @@ def _read_local(path: Path) -> str:
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['node_modules', 'venv', '_build', 'Thumbs.db', '.DS_Store', 'developer/Introduction/*']
+exclude_patterns = ['node_modules', 'venv', '_build', 'Thumbs.db', '.DS_Store']
 
 # -- Project config and MyriadRF styling --------------------------------------
 
@@ -211,7 +211,7 @@ def _read_local(path: Path) -> str:
 ## Extensions updated also
 
 breathe_projects = {
-    "Lime Suite NG" : ( "../build/docs/developer/doxygen/xml" )
+    "Lime Suite NG" : ( "../build/docs/developer/xml" )
 }
 
 breathe_default_project = "Lime Suite NG"

docs/developer/doxygen/DoxygenConfig.in → docs/developer/DoxygenConfig.in

@@ -879,7 +879,8 @@ WARN_LOGFILE           =
 # Specified INPUT path are relative to docs/doxygen directory.
 
 INPUT                  = @PROJECT_SOURCE_DIR@/src/include @PROJECT_SOURCE_DIR@/src/comms/SPI/ISPI.h @PROJECT_SOURCE_DIR@/src/comms/II2C.h
-INPUT                 += @PROJECT_SOURCE_DIR@/docs/developer/doxygen
+INPUT                 += @PROJECT_SOURCE_DIR@/docs/developer
+INPUT                 += @PROJECT_SOURCE_DIR@/src/comms/ICSR.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -975,7 +976,9 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = @PROJECT_SOURCE_DIR@/src/examples
+EXAMPLE_PATH          += @PROJECT_SOURCE_DIR@/.conda/metapkg
+EXAMPLE_PATH          += @PROJECT_SOURCE_DIR@/cli
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -995,7 +998,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             = @PROJECT_SOURCE_DIR@/docs/developer/doxygen/images/
+IMAGE_PATH             = @PROJECT_SOURCE_DIR@/docs/developer/images/
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

docs/developer/Introduction/comms.dox

@@ -0,0 +1,40 @@
+/**
+ * @page library_ctrl_comms Control communication
+ * 
+ * @if RST_SUPPORT
+ * @embedRstVerbatim{
+ * 
+ * .. mermaid:: comms.mmd
+ * 
+ * }
+ * @else
+ * @image{inline} html control_comms_fwch.png 
+ * @endif
+ * 
+ * @section ctrl_comms_summary Summary
+ * 
+ * All supported SDR device class implementations use the virtual serial interface ``ISerialPort`` to
+ * control and configure device registers. The virtual serial interface provides the base communication
+ * functions, which must be overriden by each device class implementation.
+ * 
+ * Lime Suite NG supported SDR devices override the virtual serial interface at the device registration step.
+ * Each device class implementation will override the functions with one of the following supported serial
+ * interface implementations:
+ * 
+ * - ``PCIE_CSR_Pipe`` - serial interface for communicating with PCIe interface based SDR devices.
+ * - ``FTDI_SerialPort`` - serial interface for communicating with USB interface based SDR devices, that use FT6xx USB chip.
+ * - ``FX3_SerialPort`` - serial interface for communicating with USB interface based SDR devices, that use FX3 USB chip. 
+ * 
+ * Each implementation of the serial interface communicates with a device through a communication 
+ * library port. A communication library port implements control, configuration and mass data transfer functions 
+ * for a class of devices. Communication library port implementation relies on communication library API, which 
+ * provides a set of functions that can be used to interact with device driver and thus with the device hardware.
+ * 
+ * @subsection  ctrl_comms_fwch_legend Flowchart legend
+ * 
+ * Link definitions:
+ * 
+ * - Dotted-line arrow - Inheritance. (Arrow head points to the child)
+ * - Solid-line arrow - Access call.
+ * 
+ */

docs/developer/Introduction/comms.mmd

@@ -1,32 +1,4 @@
 flowchart LR
-    subgraph End devices
-        subgraph USB devices
-            subgraph SDR["LimeSDR components"]
-                LMS7002M_SDR[LMS7002M]
-                FPGA_SDR[FPGA]
-            end
-            subgraph SDRMini["LimeSDR-Mini components"]
-                LMS7002M_Mini[LMS7002M]
-                FPGA_Mini[FPGA]
-            end
-        end
-        subgraph PCIe devices
-            subgraph X3[LimeSDR X3 components]
-                FPGA_X3[FPGA]
-                LMS7002M_X3["LMS7002M"]
-            end
-            subgraph XTRX[LimeSDR XTRX components]
-                FPGA_XTRX["FPGA"]
-                LMS7002M_XTRX["LMS7002M"]
-            end
-            subgraph MMX8[LimeSDR MMX8 components]
-                ADF4002_MMX8["ADF4002"]
-                FPGA_MMX8["FPGA"]
-                LMS7002M_MMX8["LMS7002M"]
-            end
-        end
-    end
-
     subgraph Communication libraries
         subgraph USB
             subgraph UNIX
@@ -42,33 +14,32 @@ flowchart LR
         end
     end
 
-    %% PCIe
-    ISPI-.->LMS64C_ADF_Over_PCIe_MMX8 & IComms & SlaveSelectShim
-    IComms-.->LMS64C_LMS7002M_Over_PCIe & LMS64C_FPGA_Over_PCIe & LMS64C_LMS7002M_Over_PCIe_MMX8 & LMS64C_FPGA_Over_PCIe_MMX8
-
-    SlaveSelectShim-->|X3 only|IComms
-
-    LMS64C_LMS7002M_Over_PCIe & LMS64C_FPGA_Over_PCIe-->|X3 & XTRX|PCIE_CSR_Pipe
-    LMS64C_LMS7002M_Over_PCIe_MMX8 & LMS64C_ADF_Over_PCIe_MMX8 & LMS64C_FPGA_Over_PCIe_MMX8-->|MMX8|PCIE_CSR_Pipe
-
-    ISerialPort-.->PCIE_CSR_Pipe
-    PCIE_CSR_Pipe-->LimePCIe-->limepcie
-
-    limepcie-->|XTRX|XTRX
-    limepcie-->|X3|X3
-    limepcie-->|MMX8|MMX8
-
-    %% USB
-    IComms-.->LMS64C_FPGA_Over_USB & LMS64C_LMS7002M_Over_USB-->USB_CSR_Pipe
-    ISerialPort-.->USB_CSR_Pipe
-
-    USB_CSR_Pipe-.->USB_CSR_Pipe_Mini & USB_CSR_Pipe_SDR
-    USB_CSR_Pipe_SDR-->FX3
-    USB_CSR_Pipe_Mini-->FT601
-
-    FX3-->|On Windows|Cypress-->SDR
-    FT601-->|On Windows|FTD3XX-->SDRMini
-    FX3 & FT601-->|On UNIX|libusb
+    subgraph Lime Suite NG library
+        direction LR
+        subgraph Virtual interfaces
+            ISerialPort
+        end
+        subgraph Interface implementations
+            PCIE_CSR_Pipe
+            FTDI_SerialPort
+            FX3_SerialPort
+        end
+        subgraph Communication library ports
+            LimePCIe
+            FT601
+            FX3
+        end
+    end
 
-    libusb-->|Using FT601|SDRMini 
-    libusb-->|Using FX3|SDR
+    %% Lime Suite NG library subgraph interconnections
+    ISerialPort-.->PCIE_CSR_Pipe & FTDI_SerialPort & FX3_SerialPort
+    PCIE_CSR_Pipe-->LimePCIe
+    FTDI_SerialPort-->FT601
+    FX3_SerialPort-->FX3
+
+    %% Global interconnections
+    LimePCIe-->limepcie
+    FT601-- Windows -->FTD3XX
+    FX3-- Windows -->Cypress
+    FT601-- Unix -->libusb
+    FX3-- Unix -->libusb