diff --git a/.github/workflows/pr-closed.yml b/.github/workflows/pr-closed.yml new file mode 100644 index 000000000..ec21a24d9 --- /dev/null +++ b/.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 }} diff --git a/.github/workflows/top-level.yml b/.github/workflows/top-level.yml index 496e689de..4a66040e3 100644 --- a/.github/workflows/top-level.yml +++ b/.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 diff --git a/docs/solutions/reference-designs/eval-cn0503-ardz/fluorescence-measurement/index.rst b/docs/solutions/reference-designs/eval-cn0503-ardz/fluorescence-measurement/index.rst index f6635df0b..f774d7aed 100644 --- a/docs/solutions/reference-designs/eval-cn0503-ardz/fluorescence-measurement/index.rst +++ b/docs/solutions/reference-designs/eval-cn0503-ardz/fluorescence-measurement/index.rst @@ -50,14 +50,14 @@ The following is a list of items needed in order to replicate this demo. Setting Up the EVAL-CN0503-ARDZ ------------------------------- -Before starting with these steps, please check the :ref:`Hardware User -Guide` for the steps to assembling the :adi:`CN0503`. -Additionally, please check the :ref:`Software User Guide` for -the steps in setting up the firmware and the :download:`Quick Setup Guide -` 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` for the steps to assembling the +:adi:`CN0503`. Additionally, please check the :ref:`Software User Guide ` +for the steps in setting up the firmware and the +:download:`Quick Setup Guide ` +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: diff --git a/docs/solutions/reference-designs/eval-cn0503-ardz/nitrate-measurement/index.rst b/docs/solutions/reference-designs/eval-cn0503-ardz/nitrate-measurement/index.rst index b01fdadde..081d43fc6 100644 --- a/docs/solutions/reference-designs/eval-cn0503-ardz/nitrate-measurement/index.rst +++ b/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 ` for the steps to assemble the CN0503. Additionally, please check the :ref:`Software User Guide ` for the steps in setting -up the firmware and the :download:`Quick Setup Guide -` 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 ` +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: diff --git a/docs/solutions/reference-designs/eval-ltpa-kit/software_guide/index.rst b/docs/solutions/reference-designs/eval-ltpa-kit/software_guide/index.rst index 3b9836ffb..34c0b5ba8 100644 --- a/docs/solutions/reference-designs/eval-ltpa-kit/software_guide/index.rst +++ b/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