Enable sphinx-lint rule unbalanced-inline-literals-delimiters

Author: cclauss

.pre-commit-config.yaml

@@ -21,7 +21,6 @@ repos:
     hooks:
       - id: sphinx-lint
         args:
-          - --disable=backtick-before-role
           - --disable=horizontal-tab
           - --disable=hyperlink-reference-missing-backtick
           - --disable=missing-final-newline
@@ -33,4 +32,3 @@ repos:
           - --disable=missing-underscore-after-hyperlink
           - --disable=role-without-backticks
           - --disable=trailing-whitespace
-          - --disable=unbalanced-inline-literals-delimiters

ARCHIVED/building-for-qualcomm-snapdragon-flight-kit.rst

@@ -120,7 +120,7 @@ dhcp-range=192.168.**2**.10,192.168.**2**.20,infinite
 
 Line 39 of /etc/network/interfaces.d/.qca6234.cfg.softap as shown below.
 
-`` address 192.168.2.1``
+``address 192.168.2.1``
 
 You should be able to use a terminal program such as Putty to ssh to the
 board at the IP address shown above (i.e. 192.168.2.1) using

ARCHIVED/geofencing.rst

@@ -134,7 +134,7 @@ geo-fencing behaviour:
    Note that when :ref:`FENCE_RET_RALLY<FENCE_RET_RALLY>` is set to 1 this parameter is
    ignored and the loiter altitude of the closest :ref:`Rally Point <common-rally-points>` is
    used instead.  If this parameter is zero and :ref:`FENCE_RET_RALLY<FENCE_RET_RALLY>` is
-   also zero, the midpoint of the `FENCE_MAXALT`` and ``FENCE_MINALT``
+   also zero, the midpoint of the :ref:`FENCE_ALT_MAX <FENCE_ALT_MAX>` and :ref:`FENCE_ALT_MIN <FENCE_ALT_MIN>`
    parameters is used as the return altitude.
 #. :ref:`FENCE_AUTOENABLE<FENCE_AUTOENABLE>` - if set to 1, the aircraft will boot with the
    fence disabled.  After an autonomous takeoff completes the fences

common/source/docs/common-ads-b-receiver.rst

@@ -148,7 +148,7 @@ an older version, use:
     sudo pip install --upgrade pymavlink MAVProxy
 
 Set the number of aircraft to simulate using the ``SIM_ADSB_COUNT`` parameter. Ping2020 simulation support
-can be enabled by setting parameter `'SIM_ADSB_TX``. Other simulation options for ADS-B are present, all
+can be enabled by setting parameter :ref:`SIM_ADSB_TX <SIM_ADSB_TX>`. Other simulation options for ADS-B are present, all
 starting with ``SIM_ADSB_``.
 
 Plugging in a hardware ADS-B receiver to your computer using a USB-to-Serial converter, or using the PingUSB, will allow you to overlay real ADS-B

common/source/docs/common-ark-power-modules.rst

@@ -101,7 +101,7 @@ Ardupilot Setup
 ===============
 
    -  Set the ``BATTx_MONITOR`` parameter to "INA2XX"
-   -  Set the `BATTX_SHUNT`` parameter to "0.0001"
+   -  Set the ``BATTX_SHUNT`` parameter to "0.0001"
    -  Reboot the flight controller
 
 More Information

common/source/docs/common-lua-scripts.rst

@@ -39,7 +39,7 @@ Getting Started
 
 .. note:: To download from the github locations, first click the script name, then select "raw" in upper right corner, then right mouse click to "Save Page as" a text file with the ".lua" file extension
 
-- Up to 8 RC channels can be assigned as scripting inputs/controls using the``RCX_OPTION`` = "300-307" options to be used by scripts. In addition, six dedicated script parameters are available: :ref:`SCR_USER1<SCR_USER1>` thru :ref:`SCR_USER6<SCR_USER6>` and are accessed with the same method as any other parameter, but these are reserved for script use. Scripts can also generate their own parameters (see :ref:`common-scripting-parameters`)to be used within the scripts.
+- Up to 8 RC channels can be assigned as scripting inputs/controls using the ``RCX_OPTION`` = "300-307" options to be used by scripts. In addition, six dedicated script parameters are available: :ref:`SCR_USER1<SCR_USER1>` thru :ref:`SCR_USER6<SCR_USER6>` and are accessed with the same method as any other parameter, but these are reserved for script use. Scripts can also generate their own parameters (see :ref:`common-scripting-parameters`)to be used within the scripts.
 - When the autopilot is powered on it will load and start all scripts. By default it will look in the ROMFS file system for scripts included in the firmware image by a manufacturer, and the APM/scripts directory on the SD Card (or if a SITL simulation, the base directory where the simulation was started.) This can be modified by used the :ref:`SCR_DIR_DISABLE<SCR_DIR_DISABLE>` parameter.
 - Messages and errors are sent to the ground station and, if using Mission Planner, can be viewed in the Data screen's "Messages" tab.
 - :ref:`SCR_HEAP_SIZE <SCR_HEAP_SIZE>` can be adjusted to increase or decrease the amount of memory available for scripts. The default , which varies from 43K to 204.8K depending on cpu being used, is sufficient at its smallest (43K) for small scripts, but many will require more (some applets now need 300K). The autopilot's free memory depends highly upon which features and peripherals are enabled. If this parameter is set too low, scripts may fail to run and give an out of memory pre-arm error. If set too high other autopilot features such as Terrain Following or even the EKF may fail to initialize. On autopilots with a STM32F4 microcontroller, Smart RTL (Rover, Copter) and Terrain Following (Plane, Copter) need to be nearly always disabled. These features are usually enabled by default, set :ref:`SRTL_POINTS <SRTL_POINTS>` = 0, :ref:`TERRAIN_ENABLE <TERRAIN_ENABLE>` = 0). See also :ref:`RAM Limitations<ram_limitations>` section.

common/source/docs/common-optical-flow-sensor-setup.rst

@@ -199,7 +199,7 @@ Setup for Normal Operation
 - Alternatively, GPS can work with OpticalFlow using EKF source switching.
 - See :ref:`GPS / Non-GPS Transitions <common-non-gps-to-gps>` for information on EKF source switching.
 [site wiki="plane,copter"]
-.. note:: When Copters have an optical flow sensor enabled (along with a rangefinder) and it is specified as the only horizontal position source (e.g. ``EK3_SRCx_VELXY``=OpticalFlow and ``EK3_SRCx_POSXY``=None) and the vehicle is flying in a pilot controlled mode requiring a position estimate (ie Loiter or PosHold) the vehicle will not climb above the rangefinder's maximum altitude specified in ``RNGFNDx_MAX``. This is a safety mechanism because otherwise the EKF failsafe would trigger as the vehicle flew out of rangefinder range.
+.. note:: When Copters have an optical flow sensor enabled (along with a rangefinder) and it is specified as the only horizontal position source (e.g. ``EK3_SRCx_VELXY`` = OpticalFlow and ``EK3_SRCx_POSXY`` = None) and the vehicle is flying in a pilot controlled mode requiring a position estimate (ie Loiter or PosHold) the vehicle will not climb above the rangefinder's maximum altitude specified in ``RNGFNDx_MAX``. This is a safety mechanism because otherwise the EKF failsafe would trigger as the vehicle flew out of rangefinder range.
 
 Example Video (Copter-3.4)
 ==========================

common/source/docs/common-osd-overview.rst

@@ -53,7 +53,7 @@ Several font sets are included and can be changed during runtime (and those who
 
 .. note:: Onboard font options might be limited on 1 MB boards to save memory for other features. However, font upload from SD card is supported. This allows the user to choose from up to 10 font files (named "font0.bin" - "font9.bin") placed in the root directory of your SD card. Additionally, this allows the user to easily add individualized and/or customized language charsets for the onboard OSD without the need to compile  individual firmware. Runtime font changing using the parameter :ref:`OSD_FONT<OSD_FONT>` is unaffected. 
 
-MAVftp might be a convenient option to upload files to your SD card without having to physically remove it from your autopilot. Font files, font editor, and utilities to convert to a .bin file from .mcm are `here <https://github.com/ArduPilot/ardupilot/tree/master/libraries/AP_OSD/fonts>`__. If downloading the editor or a font's .bin file from this site, be sure to use the ``Download` button, rather than selecting ``Raw``, and then right click saving, as you would the .mcm or .py files.
+MAVftp might be a convenient option to upload files to your SD card without having to physically remove it from your autopilot. Font files, font editor, and utilities to convert to a .bin file from .mcm are `here <https://github.com/ArduPilot/ardupilot/tree/master/libraries/AP_OSD/fonts>`__. If downloading the editor or a font's .bin file from this site, be sure to use the ``Download`` button, rather than selecting ``Raw``, and then right click saving, as you would the .mcm or .py files.
 
 To enable the use of external MSP OSDs or DisplayPort systems see:
 

common/source/docs/common-radio-control-calibration.rst

@@ -41,7 +41,7 @@ Check the Transmitter's Setup
   - On Copter and Rover, any remaining two or three position switches can be setup to control auxiliary functions by mapping them to channels 7 to 12
 - Note that for reversing motor controls on Plane and Rover, the throttle range is range is normally divided into two parts:
   - Reverse throttle control: From ``RCx_TRIM`` (typically 1500us) to ``RCx_MIN``, where x is usually "3" for normal RC throttle input channel. This corresponds to motor outputs from ``SERVOx_TRIM`` to ``SERVOx_MIN``, where "x" is the output controlling the motor, and assumes the ``SERVOx_REVERSE`` bit is not set.
-  - Forward throttle control: From ``RCx_TRIM`` (typically 1500us) to ``RCx_MAX``, where x is usually "3" for normal RC throttle input channel. This corresponds to motor outputs from ``SERVOx_TRIM`` to ``SERVOx_MAX`, where "x" is the output controlling the motor, and assumes the ``SERVOx_REVERSE`` bit is not set. Using a spring-loaded stick may be most convenient, as it naturally returns to the neutral (stopped) position at ``RCx_TRIM``.
+  - Forward throttle control: From ``RCx_TRIM`` (typically 1500us) to ``RCx_MAX``, where x is usually "3" for normal RC throttle input channel. This corresponds to motor outputs from ``SERVOx_TRIM`` to ``SERVOx_MAX``, where "x" is the output controlling the motor, and assumes the ``SERVOx_REVERSE`` bit is not set. Using a spring-loaded stick may be most convenient, as it naturally returns to the neutral (stopped) position at ``RCx_TRIM``.
 
   .. note:: For Plane, it is possible to use an AUX RC switch to provide easie reverse thrust control using the entire throttle stick range on non-sprung throttle sticks. Also, many set up a switch controlled mix in their RC transmitter to map throttle low stick position to output ``RCx_TRIM`` after calibration and either output RC as the stick is raised for reverse or forward operation depending on the TX switch position, giving full throttle stick range to forward or reverse operation.
 

common/source/docs/common-scripted-aerobatics-4.4.rst

@@ -139,7 +139,7 @@ Setup
 - Make sure you have Autotuned your plane and that its capable of doing aerobatics in ACRO mode well (Bixlers and flying wings only can do rolls and loops, generally, since they have insufficient yaw authority and side fuselage area...ie must be able to knife edge for full capability). This includes Autotuning the new YAW rate controller. Enable :ref:`YAW_RATE_ENABLE<YAW_RATE_ENABLE>` and set :ref:`ACRO_YAW_RATE<ACRO_YAW_RATE>` appropriately (90deg/s is a good start). When you Autotune, not only do pitch and roll, but also yaw by exercising the rudder, like pitch and roll.
 - Enable scripting, on an autopilot that is capable (F7 or H7) with :ref:`SCR_ENABLE<SCR_ENABLE>` =1, reboot and set :ref:`SCR_HEAP_SIZE<SCR_HEAP_SIZE>` = 250000 (you will need more if other scripts are running also) and :ref:`SCR_VM_I_COUNT<SCR_VM_I_COUNT>` = 200000.
 - Copy the `plane_aerobatic.lua <https://github.com/ArduPilot/ardupilot/tree/master/libraries/AP_Scripting/applets/FixedWing>`__ script into your SD card APM/scripts directory. Use the RAW view and copy to files on the SD card. Reboot.
-- If you want to activate tricks and schedules from an RC switch, assign an RC channel to ``RCx_OPTION`` = 300 for the trick activation switch (low=disable,mid=show trick number selected, high= do it) and one for 301 which is trick selection. This normally a pot or slider, but can be any switch (which limits the number of tricks to the number of switch positions). Set the ``TRIK_ENABLE`` to 1 and reboot. Then set `TRIK_COUNT`` parameter to the number of tricks (11 maximum) to be selectable by the trick selection channel. Reboot.
+- If you want to activate tricks and schedules from an RC switch, assign an RC channel to ``RCx_OPTION`` = 300 for the trick activation switch (low=disable,mid=show trick number selected, high= do it) and one for 301 which is trick selection. This normally a pot or slider, but can be any switch (which limits the number of tricks to the number of switch positions). Set the ``TRIK_ENABLE`` to 1 and reboot. Then set ``TRIK_COUNT`` parameter to the number of tricks (11 maximum) to be selectable by the trick selection channel. Reboot.
 - For each trick/schedule, set its corresponding ``TRIKn_ID/ARG1/ARG2/ARG3/ARG4`` parameters. For example, if you wish TRIK3 to be a Vertical Box, 50 meters tall, 100 meters long, with corner radii of 15 meters, set ``TRIK3_ID`` = 5, ``TRIK3_ARG1`` = 100, ``TRIK3_ARG2`` = 50, and ``TRIK3_ARG3`` = 15. Other TRIK3 argument values are ignored.
 - Setting the activation switch to mid position will identify the trick number selected by the selection channel on the ground station or TX, if running :ref:`Yaapu <common-frsky-yaapu>` telemetry.
 - You can abort out of the trick by putting activation switch low, change modes, or set selector to 0. A trick or sequence will also abort if the programmed trajectory is not being met with an error limit. This usually indicates a lack of sufficient vehicle tuning or power.