diff --git a/source/conf.py b/source/conf.py index fe71374c..0b350a83 100644 --- a/source/conf.py +++ b/source/conf.py @@ -118,3 +118,9 @@ def setup(app): suppress_warnings = ['epub.unknown_project_files'] sphinx_tabs_valid_builders = ['epub', 'linkcheck'] + +# Excluded links for linkcheck +# These should be periodically checked by hand to ensure that they are still functional +linkcheck_ignore = [ +'https://www.raspberrypi.com/software/' +] \ No newline at end of file diff --git a/source/docs/hardware/picamconfig.rst b/source/docs/hardware/picamconfig.rst index 4e053a8c..085d795f 100644 --- a/source/docs/hardware/picamconfig.rst +++ b/source/docs/hardware/picamconfig.rst @@ -52,4 +52,4 @@ Save the file, close the editor, and eject the drive. The boot configuration sho Additional Information ---------------------- -See `the libcamera documentation `_ for more details on configuring cameras. +See `the libcamera documentation `_ for more details on configuring cameras. diff --git a/source/docs/installation/sw_install/gloworm.rst b/source/docs/installation/sw_install/gloworm.rst index 77cfebb1..2dfc3454 100644 --- a/source/docs/installation/sw_install/gloworm.rst +++ b/source/docs/installation/sw_install/gloworm.rst @@ -10,7 +10,7 @@ Flashing the Gloworm Image -------------------------- Plug a USB C cable from your computer into the USB C port on Gloworm labeled with a download icon. -Use `Balena Etcher `_ to flash an image onto the coprocessor. +Use the 1.18.11 version of `Balena Etcher `_ to flash an image onto the coprocessor. Run BalenaEtcher as an administrator. Select the downloaded ``.zip`` file. @@ -18,7 +18,7 @@ Select the compute module. If it doesn't show up after 30s try using another USB Hit flash. Wait for flashing to complete, then disconnect your USB C cable. -.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Gloworm. Updating to the latest Balena Etcher will fix this issue. +.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Gloworm. Updating to 1.18.11 will fix this issue. Final Steps ----------- diff --git a/source/docs/installation/sw_install/orange-pi.rst b/source/docs/installation/sw_install/orange-pi.rst index 9e4b8f31..c99805c1 100644 --- a/source/docs/installation/sw_install/orange-pi.rst +++ b/source/docs/installation/sw_install/orange-pi.rst @@ -12,11 +12,15 @@ Flashing the Pi Image --------------------- An 8GB or larger SD card is recommended. -Use `Balena Etcher `_ to flash an image onto a Orange Pi. Select the downloaded image file, select your microSD card, and flash. +Use the 1.18.11 version of `Balena Etcher `_ to flash an image onto a Orange Pi. Select the downloaded image file, select your microSD card, and flash. For more detailed instructions on using Etcher, please see the `Etcher website `_. -.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Orange Pi. Updating to the latest Balena Etcher will fix this issue. +.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Orange Pi. Updating to 1.18.11 will fix this issue. + +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. + +Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. .. note:: If you are working on Linux, "dd" can be used in the command line to flash an image. diff --git a/source/docs/installation/sw_install/raspberry-pi.rst b/source/docs/installation/sw_install/raspberry-pi.rst index 0e950ee8..7dd61740 100644 --- a/source/docs/installation/sw_install/raspberry-pi.rst +++ b/source/docs/installation/sw_install/raspberry-pi.rst @@ -12,11 +12,15 @@ Flashing the Pi Image --------------------- An 8GB or larger card is recommended. -Use `Balena Etcher `_ to flash an image onto a Raspberry Pi. Select the downloaded ``.tar.xz`` file, select your microSD card, and flash. +Use the 1.18.11 version of `Balena Etcher `_ to flash an image onto a Raspberry Pi. Select the downloaded ``.tar.xz`` file, select your microSD card, and flash. For more detailed instructions on using Etcher, please see the `Etcher website `_. -.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to the latest Balena Etcher will fix this issue. +.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to 1.18.11 will fix this issue. + +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. + +Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. If you are using a non-standard Pi Camera connected to the CSI port, :ref:`additional configuration may be required. ` diff --git a/source/docs/installation/sw_install/snakeyes.rst b/source/docs/installation/sw_install/snakeyes.rst index fde6b7f7..971a32f5 100644 --- a/source/docs/installation/sw_install/snakeyes.rst +++ b/source/docs/installation/sw_install/snakeyes.rst @@ -10,11 +10,15 @@ Flashing the SnakeEyes Image ---------------------------- An 8GB or larger card is recommended. -Use `Balena Etcher `_ to flash an image onto a Raspberry Pi. Select the downloaded ``.zip`` file, select your microSD card, and flash. +Use the 1.18.11 version of `Balena Etcher `_ to flash an image onto a Raspberry Pi. Select the downloaded ``.zip`` file, select your microSD card, and flash. For more detailed instructions on using Etcher, please see the `Etcher website `_. -.. warning:: Using an older version of Balena Etcher may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to the latest Balena Etcher will fix this issue. +.. warning:: Using a version of Balena Etcher older than 1.18.11 may cause bootlooping (the system will repeatedly boot and restart) when imaging your Raspberry Pi. Updating to 1.18.11 will fix this issue. + +Alternatively, you can use the `Raspberry Pi Imager `_ to flash the image. + +Select "Choose OS" and then "Use custom" to select the downloaded image file. Select your microSD card and flash. Final Steps ----------- diff --git a/source/docs/pipelines/output.rst b/source/docs/pipelines/output.rst index b5ab9e9b..3ec552c5 100644 --- a/source/docs/pipelines/output.rst +++ b/source/docs/pipelines/output.rst @@ -13,7 +13,7 @@ This section also includes a switch to enable processing and sending multiple ta .. raw:: html