Staging/shared action doc

.github/workflows/pr-closed.yml

@@ -0,0 +1,14 @@
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  clean-gh-pages:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: analogdevicesinc/doctools/gh-pages-rm-path@action
+      with:
+        path: pull/${{ github.event.number }}

.github/workflows/top-level.yml

@@ -69,56 +69,18 @@ jobs:
 
   deploy:
     runs-on: ubuntu-latest
-    if: github.ref == 'refs/heads/main'
     needs: [build-doc]
     permissions:
       contents: write
+    if: >
+      github.ref == 'refs/heads/main' ||
+      github.event_name == 'pull_request' ||
+      github.ref_type == 'tag'
 
     steps:
-    - run: |
-        git config --global user.name "${{ github.event.head_commit.committer.name }}"
-        git config --global user.email "${{ github.event.head_commit.committer.email }}"
-
-    - uses: actions/checkout@v4
-    - name: Create gh-pages branch
-      run: >
-        git ls-remote --exit-code --heads origin refs/heads/gh-pages ||
-        (
-          git reset --hard ;
-          git clean -fdx ;
-          git checkout --orphan gh-pages ;
-          git reset --hard;
-          git commit -m "empty" --allow-empty ;
-          git push origin gh-pages:gh-pages
-        )
-
-    - uses: actions/checkout@v4
-      with:
-        ref: 'gh-pages'
-        lfs: 'false'
-
-    - name: Empty gh-pages
-      run: |
-        git rm -r . --quiet || true
-
-    - uses: actions/download-artifact@v4
+    - uses: analogdevicesinc/doctools/gh-pages-deploy@action
       with:
+        new_tag: ${{ github.ref_type == 'tag' }}
+        tag: ${{ github.ref_name }}
         name: html
 
-    - name: Patch doc build
-      run: |
-        rm -r _sources
-        touch .nojekyll
-
-    - name: Commit gh-pages
-      run: |
-        author=$(git log -1 --pretty=format:'%an')
-        email=$(git log -1 --pretty=format:'%ae')
-        commit=$(git rev-parse --short HEAD)
-
-        git add . >> /dev/null
-        git commit -m "deploy: ${GITHUB_SHA}" --allow-empty
-
-    - name: Push to gh-pages
-      run: >-
-        git push origin gh-pages:gh-pages

docs/solutions/reference-designs/eval-cn0503-ardz/fluorescence-measurement/index.rst

@@ -3,14 +3,14 @@
 Fluorescence Measurement Demo
 ==============================
 
 Fluorescence occurs when the electrons of certain chemical compounds are excited
 by beam of light causing them to emit light at a different and typically longer
 wavelength. The intensity of the emitted fluorescent light is linear for a broad
 range of concentration of the substance. The method of measuring fluorescence
 intensity to obtain the concentration of the material is advantageous over
 standard colorimetry due to its specificity and resistance to noise. Since only
 the target chemical compound emits light at a different wavelength, using a
 detector or optical filter which detects or passes narrowband light centered at
 that wavelength decreases interference from the source or incident light.
 
 General Description
@@ -22,12 +22,12 @@
 fluorescence involves either directly measuring the emitted light from the
 compound or from an added a reagent which introduced fluorescent material
 proportional to the concentration of the target compound. The sensor used is
 the fluorescence photodiode placed perpendicular to the light path from the
 source LED. This photodiode is sensitive to longer wavelength light than the
 transmit photodiode placed directly in the light path. Its position and
 spectral sensitivity help to remove any interference from the source LED to
 the fluorescent light samples. Additionally, an optical fluorescent filter
 (narrowband longpass filter) is inserted in the slot in front of the sensor to
 further isolate fluorescent light from noise.
 
 The demo shows how directly measuring fluorescent light from tonic water
@@ -39,9 +39,9 @@
 Demo Requirements
 -----------------
 
 The following is a list of items needed in order to replicate this demo.
 
 - :adi:`CN0503`, completely assembled (see :ref:`Hardware User Guide<eval-cn0503-ardz>`)
 - :adi:`EVAL-ADICUP3029` with firmware (see :ref:`Software User Guide<cn0503-software>`)
 - Host computer with CN0503 software (see :download:`Quick Setup Guide <cn0503_gui_quick_start_guide.docx>`)
   and Microsoft Excel (Optional for setting up computation of concentration)
@@ -50,14 +50,14 @@
 Setting Up the EVAL-CN0503-ARDZ
 -------------------------------
 
-Before starting with these steps, please check the :ref:`Hardware User
-Guide<eval-cn0503-ardz>` for the steps to assembling the :adi:`CN0503`.
-Additionally, please check the :ref:`Software User Guide<cn0503-software>` for
-the steps in setting up the firmware and the :download:`Quick Setup Guide
-<cn0503_gui_quick_start_guide.docx>` for running the software. This demo
-assumes that you already have an assembled board with a working firmware
-already programmed on the :adi:`EVAL-ADICUP3029` and a ready-to-run software in
-the host computer.
+Before starting with these steps, please check the
+:ref:`Hardware User Guide<eval-cn0503-ardz>` for the steps to assembling the
+:adi:`CN0503`. Additionally, please check the :ref:`Software User Guide <cn0503-software>`
+for the steps in setting up the firmware and the
+:download:`Quick Setup Guide <cn0503_gui_quick_start_guide.docx>`
+for running the software. This demo assumes that you already have an assembled
+board with a working firmware already programmed on the :adi:`EVAL-ADICUP3029`
+and a ready-to-run software in the host computer.
 
 Configure the on-board jumper shunt connection as below:
 
@@ -121,13 +121,13 @@
 
 #. Add empty cuvette/s (or filled with distilled water) to the cuvette holder
    assembly, and insert to path 1. Set the jumper connection of P1ASEL
    temporarily to 0DEG. This uses the transmit photodiode directly in the path
    of light from LED1 to check and measure the intensity of the light source.
 
    .. image:: fl_optimizeled.jpg
 
 #. Click the ``Optimize LED`` button. This properly sets the LED current in the path so that
    the light intensity measured by the photodetector is close to 50%.
 #. Return the P1ASEL jumper connection to 90DEG and click ``Okay`` here and on the
    settings window to go back to the main. Remove the empty cuvette or distilled
    water sample.
@@ -140,11 +140,11 @@
    .. image:: fl_cuvette.jpg
 
 #. Select path 1, set display mode to INS1, and press ``Start Measurement``. The
    concentration of quinine in g/L will be shown in a live plot as shown below.
 
    .. image:: fl_data.png
 
    For quick demo purposes, the system was configured in path 1, by default,
    using a polynomial approximation. Check the Computing Concentration
    section for more details.
 
@@ -160,9 +160,9 @@
 -----------------------
 
 The CN0503 measures the intensity of the fluorescent light through a right
 angle photodiode and the intensity of the incident light through a reference
 photodiode. A polynomial approximation for computing quinine concentration can
 be modeled using the ratios of the two intensities measured from samples of
 known values.
 
 .. important::

docs/solutions/reference-designs/eval-cn0503-ardz/nitrate-measurement/index.rst

@@ -53,11 +53,10 @@ Setting the EVAL-CN0503-ARDZ
 Before starting with these steps, please check the :ref:`Hardware User Guide
 <eval-cn0503-ardz>` for the steps to assemble the CN0503. Additionally, please
 check the :ref:`Software User Guide <cn0503-software>` for the steps in setting
-up the firmware and the :download:`Quick Setup Guide
-<cn0503_gui_quick_start_guide.docx>` for running the software. This demo
-assumes that you already have an assembled board with a working firmware
-already programmed on the :adi:`EVAL-ADICUP3029` and a ready-to-run software in
-the host computer.
+up the firmware and the :download:`Quick Setup Guide <cn0503_gui_quick_start_guide.docx>`
+for running the software. This demo assumes that you already have an assembled
+board with a working firmware already programmed on the :adi:`EVAL-ADICUP3029`
+and a ready-to-run software in the host computer.
 
 Configure the onboard jumper shunt connection as below:
 

docs/solutions/reference-designs/eval-ltpa-kit/software_guide/index.rst

@@ -561,15 +561,20 @@ and entering the break points into the table on the left. The maximum signal
 level is 500 mV pk-pk. Right-click on the table to bring up a menu which will
 help edit the data in the table.
 
-.. figure: lib1_bodeinjlvl.png
+.. figure:: lib1_bodeinjlvl.png
 
    Setting the Bode Plot Injection Level
 
-+----------------------------------------------+-----------------------------------------------+
-| .. figure:: lib2_bodeinjlvl.png              | .. figure:: lib3_bodeinjlvl.png               |
-|                                              |                                               |
-| Tapered vs. Constant 20 mV Injection Levels  | Tapered vs. Constant 100 mV Injection Levels  |
-+----------------------------------------------+-----------------------------------------------+
+.. grid::
+   :widths: 50% 50%
+
+   .. figure:: lib2_bodeinjlvl.png
+
+      Tapered vs. Constant 20 mV Injection Levels
+
+   .. figure:: lib3_bodeinjlvl.png
+
+      Tapered vs. Constant 100 mV Injection Levels
 
 With a constant 20 mV pk-pk injection level, both the gain and phase
 measurements are noticeably noisier at low frequencies because of the small
@@ -796,12 +801,17 @@ Upper Limit combo boxes.
 If the voltage waveform remains inside the box, the limit text will turn green,
 otherwise the text will be red.
 
-+--------------------------------------+--------------------------------------+
-| .. figure:: lib2_limidisp.png        | .. figure:: lib3_limidisp.png        |
-|                                      |                                      |
-| **Transient Analysis Passing Set     | **Transient Analysis Failing Set     |
-| Limits indicated by Green Text**     | Limits indicated by Red Text**       |
-+--------------------------------------+--------------------------------------+
+.. grid::
+   :widths: 50% 50%
+
+   .. figure:: lib2_limidisp.png
+
+      Transient Analysis Passing Set Limits indicated by Green Text
+
+   .. figure:: lib3_limidisp.png
+
+      Transient Analysis Failing Set Limits indicated by Red Text
+
 
 Transient Analysis Tab
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -950,7 +960,7 @@ Time combo boxes. The rise times are programmable only when the Low Current is
 set to a minimum value other than zero in order to overcome the offset of the
 amplifier in the current control loop on the current probe.
 
-.. figure::lib1_rifati.png
+.. figure:: lib1_rifati.png
 
    Transient Rise Time Comparison