docs: Replaced code-block with shell directive where needed

Signed-off-by: Iulia Moldovan <[email protected]>
analogdevicesinc · Nov 26, 2024 · 5b23567 · 5b23567
1 parent 78574ca
commit 5b23567
Show file tree

Hide file tree

Showing 50 changed files with 902 additions and 973 deletions.
diff --git a/docs/projects/ad3552r_evb/index.rst b/docs/projects/ad3552r_evb/index.rst
@@ -148,11 +148,10 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad3552r_evb/zed
-   user@analog:~/hdl/projects/ad3552r_evb/zed$ make
+   $cd hdl/projects/ad3552r_evb/zed
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 

diff --git a/docs/projects/ad408x_fmc_evb/index.rst b/docs/projects/ad408x_fmc_evb/index.rst
@@ -180,11 +180,10 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad408x_fmc_evb/zed
-   user@analog:~/hdl/projects/ad408x_fmc_evb/zed$ make
+   $cd hdl/projects/ad408x_fmc_evb/zed
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 

diff --git a/docs/projects/ad4110/index.rst b/docs/projects/ad4110/index.rst
@@ -138,18 +138,16 @@ ADI distributes the bit/elf files of these projects as part of the
 If you want to build the sources, ADI makes them available on the
 :git-hdl:`HDL repository </>`. To get the source you must
 `clone <https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository>`__
-the HDL repository, and then build the project as follows:.
+the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad4110/zed
-   user@analog:~/hdl/projects/ad4110/zed$ make
+   $cd hdl/projects/ad4110/zed
+   $make
 
-A more comprehensive build guide can be found in the :ref:`build_hdl`
-user guide.
+A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 
 Resources
 -------------------------------------------------------------------------------

diff --git a/docs/projects/ad411x_ad717x/index.rst b/docs/projects/ad411x_ad717x/index.rst
@@ -192,11 +192,10 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad411x_ad717x/de10nano
-   user@analog:~/hdl/projects/ad411x_ad717x/de10nano$ make
+   $cd hdl/projects/ad411x_ad717x/de10nano
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 

diff --git a/docs/projects/ad4134_fmc/index.rst b/docs/projects/ad4134_fmc/index.rst
@@ -177,11 +177,10 @@ the HDL repository, and then build the project as follows:.
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad4134_fmc/zed
-   user@analog:~/hdl/projects/ad4134_fmc/zed$ make
+   $cd hdl/projects/ad4134_fmc/zed
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl`
 user guide.

diff --git a/docs/projects/ad4170_asdz/index.rst b/docs/projects/ad4170_asdz/index.rst
@@ -208,17 +208,15 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad4170_asdz/coraz7s
-   user@analog:~/hdl/projects/ad4170_asdz/coraz7s$ make
+   $cd hdl/projects/ad4170_asdz/coraz7s
+   $make
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad4170_asdz/de10nano
-   user@analog:~/hdl/projects/ad4170_asdz/de10nano$ make
+   $cd hdl/projects/ad4170_asdz/de10nano
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 

diff --git a/docs/projects/ad4630_fmc/index.rst b/docs/projects/ad4630_fmc/index.rst
@@ -332,11 +332,10 @@ the HDL repository, and then build the project as follows:.
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad4630_fmc/zed
-   user@analog:~/hdl/projects/ad4630_fmc/zed$ make NUM_OF_SDI=4 CAPTURE_ZONE=2
+   $cd hdl/projects/ad4630_fmc/zed
+   $make NUM_OF_SDI=4 CAPTURE_ZONE=2
 
 The result of the build, if parameters were used, will be in a folder named
 by the configuration used:

diff --git a/docs/projects/ad469x_evb/index.rst b/docs/projects/ad469x_evb/index.rst
@@ -107,15 +107,15 @@ modifications need to be done on the board and/or ``make`` command:
 
 In case we link CNV signal to PWM:
 
-.. code-block::
+.. shell:: bash
 
-   make SPI_4WIRE=0
+   $make SPI_4WIRE=0
 
 In case we link CNV signal to SPI_CS:
 
-.. code-block::
+.. shell:: bash
 
-   make SPI_4WIRE=1
+   $make SPI_4WIRE=1
 
 CPU/Memory interconnects addresses
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -282,10 +282,10 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad469x_evb/zed
-   user@analog:~/hdl/projects/ad469x_evb/zed$ make SPI_4WIRE=0
+   $cd hdl/projects/ad469x_evb/zed
+   $make SPI_4WIRE=0
 
 The result of the build, if parameters were used, will be in a folder named
 by the configuration used:

diff --git a/docs/projects/ad485x_fmcz/index.rst b/docs/projects/ad485x_fmcz/index.rst
@@ -179,10 +179,10 @@ make command by typing in your command prompt (this example is for
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad485x_fmc/zed
-   user@analog:~$ make
+   $cd hdl/projects/ad485x_fmc/zed
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user
 guide.

diff --git a/docs/projects/ad5758_sdz/index.rst b/docs/projects/ad5758_sdz/index.rst
@@ -34,22 +34,22 @@ Applications:
 Supported boards
 -------------------------------------------------------------------------------
 
--  :adi:`EVAL-AD5758 <EVAL-AD5758>`
+- :adi:`EVAL-AD5758`
 
 Supported devices
 -------------------------------------------------------------------------------
 
--  :adi:`AD5758`
+- :adi:`AD5758`
 
 Supported carriers
 -------------------------------------------------------------------------------
 
--  :xilinx:`ZedBoard <products/boards-and-kits/1-8dyf-11.html>` on FMC slot
+- :xilinx:`ZedBoard <products/boards-and-kits/1-8dyf-11.html>` on FMC slot
 
 Other required hardware
 -------------------------------------------------------------------------------
 
--  :adi:`SDP-S`
+- :adi:`SDP-S`
 
 Block design
 -------------------------------------------------------------------------------
@@ -106,7 +106,7 @@ GPIOs
 
 The Software GPIO number is calculated as follows:
 
--  Zynq-7000: if PS7 is used, then the offset is 54
+- Zynq-7000: if PS7 is used, then the offset is 54
 
 .. list-table::
    :widths: 25 25 25 25
@@ -146,28 +146,26 @@ the HDL repository, and then build the project as follows:.
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad5758_sdz/zed
-   user@analog:~/hdl/projects/ad5758_sdz/zed$ make
+   $cd hdl/projects/ad5758_sdz/zed
+   $make
 
-A more comprehensive build guide can be found in the :ref:`build_hdl`
-user guide.
+A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 
 Resources
 -------------------------------------------------------------------------------
 
 Hardware related
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
--  Product datasheet: :adi:`AD5758`
--  :adi:`UG-1268: EVAL-AD5758 Board User Guide <media/en/technical-documentation/user-guides/eval-ad5758-ug-1268.pdf>`
+- Product datasheet: :adi:`AD5758`
+- :adi:`UG-1268: EVAL-AD5758 Board User Guide <media/en/technical-documentation/user-guides/eval-ad5758-ug-1268.pdf>`
 
 HDL related
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
--  :git-hdl:`AD5758-SDZ HDL project source code <projects/ad5758_sdz>`
+- :git-hdl:`AD5758-SDZ HDL project source code <projects/ad5758_sdz>`
 
 .. list-table::
    :widths: 30 35 35
@@ -213,9 +211,9 @@ Linux support:
 
 No-OS support:
 
--  :git-no-os:`AD5758-SDZ No-OS project source code <projects/ad5758-sdz>`
--  :git-no-os:`AD5758 No-OS Driver source code <drivers/dac/ad5758>`
--  :dokuwiki:`AD5758 No-OS Driver documentation <resources/tools-software/uc-drivers/ad5758>`
+- :git-no-os:`AD5758-SDZ No-OS project source code <projects/ad5758-sdz>`
+- :git-no-os:`AD5758 No-OS Driver source code <drivers/dac/ad5758>`
+- :dokuwiki:`AD5758 No-OS Driver documentation <resources/tools-software/uc-drivers/ad5758>`
 
 .. include:: ../common/more_information.rst
 

diff --git a/docs/projects/ad5766_sdz/index.rst b/docs/projects/ad5766_sdz/index.rst
@@ -192,11 +192,10 @@ the HDL repository, and then build the project as follows:
 
 **Linux/Cygwin/WSL**
 
-.. code-block::
-   :linenos:
+.. shell::
 
-   user@analog:~$ cd hdl/projects/ad5766_sdz/zed
-   user@analog:~/hdl/projects/ad5766_sdz/zed$ make
+   $cd hdl/projects/ad5766_sdz/zed
+   $make
 
 A more comprehensive build guide can be found in the :ref:`build_hdl` user guide.
 
@@ -261,7 +260,7 @@ HDL related
      - :git-hdl:`library/util_i2c_mixer`
      - ---
 
--  :ref:`SPI Engine Framework documentation <spi_engine>`
+- :ref:`SPI Engine Framework documentation <spi_engine>`
 
 Software related
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~