Link-update

Links reversed to the internal structure. Bug and typo fixes. Added internal references.
RedPitaya · Mar 22, 2023 · a96753f · a96753f
2 parents eca3d91 + 56acc31
commit a96753f
Show file tree

Hide file tree

Showing 28 changed files with 87 additions and 112 deletions.
diff --git a/appsFeatures/applications/logic/logic.rst b/appsFeatures/applications/logic/logic.rst
@@ -1,3 +1,5 @@
+.. _la_app:
+
 ##############
 Logic Analyzer
 ##############
@@ -115,15 +117,12 @@ The Logic analyzer extension module is recommended for maximum performance of th
 
 .. figure:: Slika_09_LA.png
 
-To use the Logic Analyzer without the extension module, you need to be more careful in connecting the logic analyzer probes to the |E1| on the Red Pitaya board. The pins used for the logic analyzer board are shown in the picture below.
-
+To use the Logic Analyzer without the extension module, you need to be more careful in connecting the logic analyzer probes to the :ref:`E1 <E1>` on the Red Pitaya board. The pins used for the logic analyzer board are shown in the picture below.
 
-.. |E1| raw:: html
 
-   <a href="https://redpitaya.readthedocs.io/en/latest/developerGuide/hardware/125-14/extent.html#extension-connector-e1/" target="_blank">extension connector E1</a>
 
 .. note::
 
-    Direct use of the GPIO |E1| pins of the Red Pitaya board works only with STEMlab 125-10! The connection for the STEMlab 125-10 board is shown in the image below (left).
+    Direct use of the GPIO :ref:`E1 <E1>` pins of the Red Pitaya board works only with STEMlab 125-10! The connection for the STEMlab 125-10 board is shown in the image below (left).
 
 .. figure:: Slika_10_LA.png
diff --git a/appsFeatures/applications/marketplace/Lock-in.rst b/appsFeatures/applications/marketplace/Lock-in.rst
@@ -1,3 +1,5 @@
+.. _lockInPID_app:
+
 *******************************
 Lock-in + PID (by Marcelo Luda)
 *******************************

diff --git a/appsFeatures/applications/marketplace/PyRPL.rst b/appsFeatures/applications/marketplace/PyRPL.rst
@@ -1,3 +1,5 @@
+.. _pyrpl_app:
+
 ************************************************************************
 PyRPL (Lock-in amplifiers, digital filters and more by Leonhard Neuhaus)
 ************************************************************************

diff --git a/appsFeatures/applications/marketplace/daq_server.rst b/appsFeatures/applications/marketplace/daq_server.rst
@@ -1,3 +1,5 @@
+.. _daq_server_app:
+
 *********************
 Red Pitaya DAQ Server
 *********************

diff --git a/appsFeatures/applications/marketplace/dsp.rst b/appsFeatures/applications/marketplace/dsp.rst
@@ -1,3 +1,5 @@
+.. _dsp_app:
+
 **********************************************************
 DSP Sandbox (free graphical DSP design tool by Pau Gomez)
 **********************************************************

diff --git a/appsFeatures/applications/marketplace/epics.rst b/appsFeatures/applications/marketplace/epics.rst
@@ -1,3 +1,5 @@
+.. _epics_app:
+
 *********************************************
 EPICS driver for Red Pitaya (by Andraz Pozar)
 *********************************************

diff --git a/appsFeatures/applications/marketplace/freq_res_anal.rst b/appsFeatures/applications/marketplace/freq_res_anal.rst
@@ -1,3 +1,5 @@
+.. _freqRes_app:
+
 ***************************
 Frequency Response Analyzer
 ***************************

diff --git a/appsFeatures/applications/marketplace/impedance.rst b/appsFeatures/applications/marketplace/impedance.rst
@@ -1,3 +1,5 @@
+.. _imp_anal_app:
+
 ******************
 Impedance Analyzer
 ******************

diff --git a/appsFeatures/applications/marketplace/lti.rst b/appsFeatures/applications/marketplace/lti.rst
@@ -1,3 +1,5 @@
+.. _lti_dsp_app:
+
 *****************
 LTI DSP Workbench
 *****************

diff --git a/appsFeatures/applications/marketplace/marketplace.rst b/appsFeatures/applications/marketplace/marketplace.rst
@@ -1,3 +1,5 @@
+.. _marketplace:
+
 ################################
 Marketplace and contributed apps
 ################################
@@ -6,7 +8,12 @@ Marketplace and contributed apps
 Overview
 ********
 
-More Red Pitaya applications can be obtained from the Red Pitaya marketplace that is accessible through the Red Pitaya WEB interface or from other websites where Red Pitaya community members share code or complete software packages that can be installed and run on Red Pitaya hardware platforms. It is important to note that applications developed by the Red Pitaya community are not distributed or tested by the Red Pitaya team, and that our team accepts no responsibility. If you’d like to share feedback, report bugs, or need help on contributed projects, apps, or software, we highly recommend contacting the project authors.
+More Red Pitaya applications can be obtained from the Red Pitaya marketplace that is accessible through the Red Pitaya WEB interface or from other websites where Red Pitaya community members share code or complete software packages that can be installed and run on Red Pitaya hardware platforms.
+
+.. note:: 
+
+   It is important to note that applications developed by the Red Pitaya community are not distributed or tested by the Red Pitaya team, and that our team accepts no responsibility. If you’d like to share feedback, report bugs, or need help on contributed projects, apps, or software, we highly recommend contacting the project authors.
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/appsFeatures/applications/marketplace/multi_pulse_anal.rst b/appsFeatures/applications/marketplace/multi_pulse_anal.rst
@@ -1,3 +1,5 @@
+.. _multiPulse_app:
+
 *****************************************************
 Multichannel Pulse Height Analyzer – (by Pavel Demin)
 *****************************************************

diff --git a/appsFeatures/applications/marketplace/ocra.rst b/appsFeatures/applications/marketplace/ocra.rst
@@ -1,3 +1,5 @@
+.. _ocra_app:
+
 **********************************************************
 OCRA – Open Source Console for Real-Time Acquisition / MRI
 **********************************************************

diff --git a/appsFeatures/applications/marketplace/pid.rst b/appsFeatures/applications/marketplace/pid.rst
@@ -1,3 +1,5 @@
+.. _pid_app:
+
 **************
 PID controller
 **************

diff --git a/appsFeatures/applications/marketplace/power_anal.rst b/appsFeatures/applications/marketplace/power_anal.rst
@@ -1,3 +1,5 @@
+.. _power_anal_app:
+
 **************
 Power Analyzer
 **************

diff --git a/appsFeatures/applications/marketplace/qt.rst b/appsFeatures/applications/marketplace/qt.rst
@@ -1,3 +1,5 @@
+.. _qt_gui_app:
+
 ****************************************************
 Qt GUI application on Red Pitaya (by Primoz Beltram)
 ****************************************************

diff --git a/appsFeatures/applications/marketplace/radar.rst b/appsFeatures/applications/marketplace/radar.rst
@@ -1,3 +1,5 @@
+.. _radar_app:
+
 ****************************
 Open source Red Pitaya Radar
 ****************************

diff --git a/appsFeatures/applications/marketplace/radiobox.rst b/appsFeatures/applications/marketplace/radiobox.rst
@@ -1,3 +1,5 @@
+.. _radioBox_app:
+
 ****************************
 RadioBox - (by Urlich Habel)
 ****************************

diff --git a/appsFeatures/applications/marketplace/sdr.rst b/appsFeatures/applications/marketplace/sdr.rst
@@ -1,3 +1,5 @@
+.. _sdr_app:
+
 *********************************************
 SDR – Software Defined Radio (by Pavel Demin)
 *********************************************

diff --git a/appsFeatures/applications/marketplace/tesla.rst b/appsFeatures/applications/marketplace/tesla.rst
@@ -1,3 +1,5 @@
+.. _tesla_app:
+
 **********
 Teslameter
 **********

diff --git a/appsFeatures/applications/marketplace/vna.rst b/appsFeatures/applications/marketplace/vna.rst
@@ -1,3 +1,5 @@
+.. _vna_market_app:
+
 ****************************************
 Vector Network Analyzer (by Pavel Demin)
 ****************************************

diff --git a/appsFeatures/applications/marketplace/wspr.rst b/appsFeatures/applications/marketplace/wspr.rst
@@ -1,3 +1,5 @@
+.. _wspr_transc_app:
+
 *********************************************
 Multiband WSPR Transceiver – (by Pavel Demin)
 *********************************************

diff --git a/appsFeatures/applications/oscSigGen/osc.rst b/appsFeatures/applications/oscSigGen/osc.rst
@@ -1,3 +1,6 @@
+
+.. _osc_app:
+
 Oscilloscope & Signal Generator
 ###############################
 
@@ -105,11 +108,6 @@ The available settings by device model:
         - **Input attenuation:** 1:1 (± 1V) / 1:20 (± 20V) is selected automatically when adjusting V/div setting, user can also select range manually through WEB interface settings.
         - **AC/DC coupling**
 
-
-.. |analog inputs| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/developerGuide/hardware/125-14/fastIO.html#analog-inputs" target="_blank">position</a>
-
 
 Outputs
 =======
@@ -206,11 +204,6 @@ The Source parameter defines the source used for this purpose. With the IN1 or t
 
       BNC connector available on the front panel
 
-.. |E1| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/developerGuide/hardware/125-14/extent.html#extension-connector-e1" target="_blank">E1</a>
-
-
 
 
 External ref. clock (only SIGNALlab 250-12)

diff --git a/appsFeatures/applications/sdr/appSDR.rst b/appsFeatures/applications/sdr/appSDR.rst
@@ -1,3 +1,5 @@
+.. _sdr_trans_app:
+
 SDR
 ###
 

diff --git a/appsFeatures/applications/spectrum/spectrum.rst b/appsFeatures/applications/spectrum/spectrum.rst
@@ -1,3 +1,5 @@
+.. _spec_anal_app:
+
 Spectrum Analyzer
 #################
 
@@ -77,11 +79,8 @@ Horizontal +/- buttons are used to select the span of the X (frequency) axis (zo
 OUTPUTS:
 ========
 
-The Spectrum Analyzer applications also includes a signal generator, so users can simultaneously generate a signal and observe the signal spectrum. For the signal generator settings and specifications, refer to |outputs|.
-
-.. |outputs| raw:: html
+The Spectrum Analyzer applications also includes a signal generator, so users can simultaneously generate a signal and observe the signal spectrum. For the signal generator settings and specifications, refer to :ref:`outputs <output-ref>`.
 
-    <a href="https://redpitaya.readthedocs.io/en/latest/appsFeatures/applications/oscSigGen/osc.html#output-ref" target="_blank">outputs</a>
 
 External reference clock (SIGNALlab 250-12 only):
 ============================================

diff --git a/appsFeatures/applications/streaming/appStreaming.rst b/appsFeatures/applications/streaming/appStreaming.rst
@@ -28,11 +28,7 @@ Streamed data can be stored into:
 Max. streaming speeds are limited to:
 
     * 10 MB/s for streaming to an SD card (SD card class 10 is recommended for the optimal streaming performance)
-    * 20 MB/s for streaming over 1 Gbit network (A |direct connection| is recommended to achieve the best streaming performance)
-
-.. |direct connection| raw:: html
-
-    <a href="https://redpitaya.readthedocs.io/en/latest/quickStart/connect/connect.html#direct-ethernet-cable-connection" target="_blank">direct ethernet connection</a>
+    * 20 MB/s for streaming over 1 Gbit network (A :ref:`direct connection <dir_cab_connect>` is recommended to achieve the best streaming performance)
 
 
 ********************************************
@@ -101,7 +97,7 @@ Start using the Red Pitaya streaming feature
 
             Data streaming can be stopped by pressing *Ctrl + C*.
 
-            The created wav file can be read or viewed in `Audacity <https://www.audacityteam.org/>`__:
+            The created wav file can be read or viewed in |Audacity|:
 
             .. figure:: img/audacity.png
                 :width: 80%
@@ -119,7 +115,7 @@ Start using the Red Pitaya streaming feature
 
             Data streaming can be stopped by pressing *Ctrl + C*.
 
-            The created tdms file can be read or viewed in `DIAdem <https://www.ni.com/en-us/shop/data-acquisition-and-control/application-software-for-data-acquisition-and-control-category/what-is-diadem.html>`__.
+            The created tdms file can be read or viewed in |DIAdem|.
 
             .. figure:: img/diadem_tdms_file_viewer.png
                 :width: 80%

diff --git a/developerGuide/hardware/125-14/top.rst b/developerGuide/hardware/125-14/top.rst
@@ -105,7 +105,7 @@ The ADC clock can be provided by:
 
 .. warning::
 
-    Any sort of hardware modification not done by the Red Pitaya will void the warranty.
+    We do not advise altering the board because users have reported problems after doing so. Every board made has undergone rigorous testing, which cannot be claimed for modified boards. Any non-Red Pitaya hardware modification will void the warranty, and we cannot guarantee support for modified boards.
 
 ************
 Certificates

diff --git a/quickStart/SDcard/SDcard.rst b/quickStart/SDcard/SDcard.rst
@@ -32,7 +32,7 @@ RedPitaya OS 2.0:
 
 .. warning::
 
-   If you have a very old Red Pitaya (STEMlab 125-14) and the UNIFIED OS does not work for you, please send us the picture of the board (MAC address), so that we can add the address range to the system.
+   If you have a very old Red Pitaya (STEMlab 125-14, SDRlab 122-16) and the UNIFIED OS does not work for you, please send us the picture of the board (QR code), so that we can add the board model to the system.
 
 .. warning::