doc: replaced video display method to avoid using html

Also fixed warnings related to duplication of reference Signed-off-by: IonutMuthi <[email protected]>
analogdevicesinc · Aug 19, 2024 · d4a7e33 · d4a7e33
1 parent 4665e79
commit d4a7e33
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 80 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -2,14 +2,13 @@ Scopy
 ===============================================================================
 
 `Analog Devices Inc. <https://www.analog.com>`__
-HDL libraries and projects for various reference design and prototyping systems.
 This repository contains Scopy plugins information
 
 .. note::
 
-   We are in the process of moving the HDL documentation from
+   We are in the process of moving the Scopy documentation from
    `wiki <https://wiki.analog.com/university/tools/m2k/scopy#user_guides>`__
-   to :git-hdl:`/`.
+   to :git-scopy:`/dev`.
 
    We apologize for any inconvenience that may occur due to this migration.
 

diff --git a/doc/plugins/m2k/digitalio.rst b/doc/plugins/m2k/digitalio.rst
@@ -6,11 +6,8 @@ Digital IO
 
     **Video guide:**
 
-.. raw:: html
+.. video:: https://www.youtube.com/watch?v=9cYstnAoUpk  
 
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/9cYstnAoUpk" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
 
 |
 

diff --git a/doc/plugins/m2k/logic_analyzer.rst b/doc/plugins/m2k/logic_analyzer.rst
@@ -6,17 +6,11 @@ Logic Analyzer
 
     **Video guide:**
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/zWX7VnKDYq4" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
+.. video:: https://www.youtube.com/watch?v=zWX7VnKDYq4  
 
 |
 
 
-
-
 General 
 ----------------------------------------------------------------------------
 

diff --git a/doc/plugins/m2k/network_analyzer.rst b/doc/plugins/m2k/network_analyzer.rst
@@ -6,13 +6,7 @@ Network Analyzer
 
 	**Video guide:**
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/VZqPyR455UE" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
-|
+.. video:: https://www.youtube.com/watch?v=VZqPyR455UE  
 
 
 Introduction

diff --git a/doc/plugins/m2k/oscilloscope.rst b/doc/plugins/m2k/oscilloscope.rst
@@ -15,17 +15,11 @@ To switch to this instrument click on the **Oscilloscope** button from the left
 
 	**Video guide:**
 
+.. video:: https://www.youtube.com/watch?v=zWX7VnKDYq4  
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/zWX7VnKDYq4" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
 |
 
 
-
 General
 -------------------------------------------------------------------------------------------
 

diff --git a/doc/plugins/m2k/pattern_generator.rst b/doc/plugins/m2k/pattern_generator.rst
@@ -6,11 +6,8 @@ Pattern Generator
 
 	**Video guide:**
 
-.. raw:: html
+.. video:: https://www.youtube.com/watch?v=kohIqwrlmjI  
 
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/kohIqwrlmjI" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
 
 |
 

diff --git a/doc/plugins/m2k/power_supply.rst b/doc/plugins/m2k/power_supply.rst
@@ -6,12 +6,8 @@ Power Supply
 
 	**Video guide:**
 
+.. video:: https://www.youtube.com/watch?v=kohIqwrlmjI  
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/kohIqwrlmjI" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
 
 |
 

diff --git a/doc/plugins/m2k/signal_generator.rst b/doc/plugins/m2k/signal_generator.rst
@@ -5,13 +5,8 @@ Signal Generator
 
 	**Video guide:**
 
-.. raw:: html
+.. video:: https://www.youtube.com/watch?v=zWX7VnKDYq4  
 
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/zWX7VnKDYq4" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
-|
 
 
 General Description
@@ -51,8 +46,8 @@ Buffer signal type takes a file as an input. The supported file types for buffer
 * .csv - Comma separated values
 * .mat - MATLAB Mat format
 
-CSV file format supports raw CSVs such as `this <https://gist.github.com/adisuciu/7aa30bc9e545db23a17e86d23ae4f53c>`_, as well as Scopy formatted CSVs such as  
-`this <https://gist.github.com/adisuciu/5abffa8233707c7b95585e80fbb1dde9>`_ This means it is possible to acquire a signal in the oscilloscope and play it back in the signal generator.
+CSV file format supports raw CSVs such as `this <https://gist.github.com/adisuciu/7aa30bc9e545db23a17e86d23ae4f53c>`__ , as well as Scopy formatted CSVs such as  
+`this <https://gist.github.com/adisuciu/5abffa8233707c7b95585e80fbb1dde9>`__ This means it is possible to acquire a signal in the oscilloscope and play it back in the signal generator.
 
 
 	This in not entirely true. The scope sample rate is 100 MSPS (or factors of ten less) and the signal generator sample rate is 75MSPS (or factors of 10 less) so scope samples do not inherently match up with generator samples. Scope samples would need to be re-sampled by a factor of 3 to 4 to have the signal frequency played back properly.

diff --git a/doc/plugins/m2k/spectrum_analyzer.rst b/doc/plugins/m2k/spectrum_analyzer.rst
@@ -5,13 +5,8 @@ Spectrum Analyzer
 
 	**Video guide:**
 
-.. raw:: html
+.. video:: https://www.youtube.com/watch?v=lsfvpkSOoPA  
 
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/lsfvpkSOoPA" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
-|
 
 
 General Description
@@ -77,7 +72,7 @@ The channel setting allows the user to set the desired computation or variations
 * **Blackman-Harris:** The Blackman-Harris window is a very good window to use with FFT analyzers. It has better amplitude accuracy than the Hanning, very good selectivity, and the fastest filter rolloff. The filter is steep and narrow and reaches a lower attenuation than the other windows. This allows signals close together in frequency to be distinguished, even when their amplitudes are very different.
 * **Kaiser :** The Kaiser window, combines excellent selectivity and reasonable accuracy. The Kaiser window has the lowest side-lobes and the least broadening for non-bin frequencies. Because of these properties, it is the best window to use for measurements requiring a large dynamic range.
 
-Visit `this <https://ccrma.stanford.edu/~jos/sasp/Spectrum_Analysis_Windows.html>`_ for a detailed explanation
+Visit `this <https://ccrma.stanford.edu/~jos/sasp/Spectrum_Analysis_Windows.html>`__ for a detailed explanation
 
 
     For the description of the Averaging Types see below:

diff --git a/doc/plugins/m2k/voltmeter.rst b/doc/plugins/m2k/voltmeter.rst
@@ -6,12 +6,8 @@ Voltmeter
 
 	**Video guide:**
 
+.. video:: https://www.youtube.com/watch?v=kohIqwrlmjI  
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/kohIqwrlmjI" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
 
 |
 

diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
@@ -31,8 +31,8 @@ Download
 
 .. warning::
 
-  In order to have Scopy working with `ADALM2000 <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ADALM2000.html>`_  please make sure that the Device Drivers are installed. A guide on this topic can be found in the section:
-    * `ADALM2000 for End Users <https://wiki.analog.com/university/tools/m2k/users>`_ 
+  In order to have Scopy working with `ADALM2000 <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ADALM2000.html>`__  please make sure that the Device Drivers are installed. A guide on this topic can be found in the section:
+    * `ADALM2000 for End Users <https://wiki.analog.com/university/tools/m2k/users>`__ 
 
 Installation
 ---------------------------------------------------------------------
@@ -43,13 +43,7 @@ Once you downloaded the installer, run it and follow all the required steps. Aft
 
 Video intalation guide:
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/894HkVXf7-U" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
-|
+.. video:: https://www.youtube.com/watch?v=894HkVXf7-U
 
 
   **Scopy for Linux**
@@ -81,12 +75,7 @@ After this, get the Scopy.flatpak file from the downloaded archive and run:
 
 Video intalation guide:
 
-
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/9qgxmmTrcSE" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
+.. video:: https://www.youtube.com/watch?v=9qgxmmTrcSE
 
 |
 
@@ -98,21 +87,15 @@ Drag the application from the .dmg window into Applications to install and wait
 
 Video intalation guide:
 
+.. video:: https://www.youtube.com/watch?v=To0ACQ77tkg
 
-.. raw:: html
-
-    <div style="text-align: center;"> 
-   <iframe width="560" height="315" src="https://www.youtube.com/embed/To0ACQ77tkg" frameborder="0" align="center" allowfullscreen></iframe>
-    </div>
-
-|
 
 
   **Scopy for Android**
 
 Tap on the downloaded .apk file to start the installation process and proceed by hitting the “Install” button. Optionally, you may be warned that this application comes from unknown sources, hit the “Install anyway” button. Now, you can find “Scopy” together with your other apps.
 
-In order to connect `ADALM2000 <https://www.analog.com/ADALM2000>`_  to your device, you will need an OTG adapter that will mediate the connection between your device and the USB cable, as shown in the image below.
+In order to connect `ADALM2000 <https://www.analog.com/ADALM2000>`__  to your device, you will need an OTG adapter that will mediate the connection between your device and the USB cable, as shown in the image below.
 
 .. image:: ../resources/scopy-android-setup-example.png
     :align: center
@@ -294,3 +277,6 @@ Source code
 
 The source code for the entire application can be found on `github <https://github.com/analogdevicesinc/scopy>`_ 
 
+
+
+