Merge pull request #7092 from wxtim/doc.cylc-doc.884.follow-up

Use :envvar: reference to environment variables reference in

Author: oliver-sanders

cylc/flow/cfgspec/globalcfg.py

@@ -542,8 +542,8 @@
 Submission retry delays is a list of ISO 8601 durations which tell Cylc
 how long to wait before the next try.
 
-The job environment variable ``$CYLC_TASK_SUBMIT_NUMBER`` increments with each
-job submission attempt.
+The job environment variable :envvar:`CYLC_TASK_SUBMIT_NUMBER` increments
+with each job submission attempt.
 
 Tasks only go to the ``submit-failed`` state if job submission fails with no
 retries left.
@@ -1092,8 +1092,8 @@ def default_for(
             How Cylc determines and shares the identity of the workflow host.
 
             The workflow host's identity must be determined locally by cylc and
-            passed to running tasks (via ``$CYLC_WORKFLOW_HOST``) so that task
-            messages can target the right workflow on the right host.
+            passed to running tasks (via :envvar:`CYLC_WORKFLOW_HOST`) so that
+            task messages can target the right workflow on the right host.
 
             .. versionchanged:: 8.0.0
 

cylc/flow/cfgspec/workflow.py

@@ -833,7 +833,7 @@ def get_script_common_text(this: str, example: Optional[str] = None):
                 Externally triggered tasks (see :ref:`Old-Style External
                 Triggers`) wait on external events reported via the
                 ``cylc ext-trigger`` command. To constrain triggers to a
-                specific cycle point, include ``$CYLC_TASK_CYCLE_POINT``
+                specific cycle point, include :envvar:`CYLC_TASK_CYCLE_POINT`
                 in the trigger message string and pass the cycle point to the
                 ``cylc ext-trigger`` command.
             ''')
@@ -1360,7 +1360,8 @@ def get_script_common_text(this: str, example: Optional[str] = None):
 
                 Job scripts are executed from within *work directories*
                 created automatically under the workflow run directory. A task
-                can get its own work directory from ``$CYLC_TASK_WORK_DIR``
+                can get its own work directory from
+                :envvar:`CYLC_TASK_WORK_DIR`
                 (or ``$PWD`` if it does not ``cd`` elsewhere at
                 runtime). The default directory path contains task name and
                 cycle point, to provide a unique workspace for every instance
@@ -1397,7 +1398,7 @@ def get_script_common_text(this: str, example: Optional[str] = None):
                 Execution retry delays is a list of ISO 8601 durations which
                 tell Cylc how long to wait before the next try.
 
-                The job environment variable ``$CYLC_TASK_TRY_NUMBER``
+                The job environment variable :envvar:`CYLC_TASK_TRY_NUMBER`
                 increments with each automatic retry, allowing you to vary task
                 behaviour between retries.