docs: Fix rst-style urls in the documentation (#1640)

* docs: Fix rst-style urls in the documentation

* feat: Skip test CI if the pull requests is documentation only

Author: bhirsz

.github/workflows/tests.yml

@@ -31,6 +31,10 @@ jobs:
             python-version: '3.14'
             rf-version: '7.*'
     runs-on: ${{ matrix.os }}
+    # Skip for documentation-only builds
+    if: >
+      github.event_name != 'pull_request' ||
+      !contains(github.event.pull_request.labels.*.name, 'docs-only')
 
     steps:
       - name: Checkout

src/robocop/linter/rules/comments.py

@@ -190,8 +190,7 @@ class IgnoredDataRule(Rule):
     """
     Ignored data found in the file.
 
-    All lines before the first test data section
-    (`ref <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#test-data-sections>`_)
+    All lines before the first test data section ([ref](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#test-data-sections))
     are ignored. It's recommended to add a `` *** Comments *** `` section header for lines that should be ignored.
 
     Missing section header:

src/robocop/linter/rules/tags.py

@@ -52,8 +52,7 @@ class TagWithOrAndRule(Rule):
         robocop check --include tagANDtag2
 
     Robot Framework will only execute tests that contain ``tag`` and ``tag2``. That's why it's best to avoid ``AND``
-    and ``OR`` in tag names. See
-    `docs <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns>`_
+    and ``OR`` in tag names. See [docs](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns)
     for more information.
 
     Tag matching is case-insensitive. If your tag contains ``OR`` or ``AND`` you can use lowercase to match it.
@@ -76,9 +75,9 @@ class TagWithReservedWordRule(Rule):
     """
     Tag is prefixed with reserved work ``robot:``.
 
-    ``robot:`` prefix is used by Robot Framework special tags. More details
-    `here <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#reserved-tags>`_.
-    Special tags currently in use:
+    ``robot:`` prefix is used by Robot Framework special tags. More details in
+    [RF User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#reserved-tags).
+    Special tags that are currently in use:
 
         - robot:exit
         - robot:flatten

src/robocop/linter/rules/variables.py

@@ -478,9 +478,9 @@ class OverwritingReservedVariableRule(Rule):
     Variable overwrites reserved variable.
 
     Overwriting reserved variables may bring unexpected results.
-    For example, overwriting variable with name ``${LOG_LEVEL}`` can break Robot Framework logging.
+    For example, overwriting a variable with the name ``${LOG_LEVEL}`` can break Robot Framework logging.
     See the full list of reserved variables at
-    `Robot Framework User Guide <https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#automatic-variables>`_
+    [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#automatic-variables).
 
     """