Merge pull request #842 from wxtim/Document-extra-task-modifiers

Document new task modifiers in Cylc GUI/TUI

Author: wxtim

src/conf.py

@@ -26,6 +26,31 @@
 
 from cylc_release import CYLC_RELEASE
 
+
+def generate_task_icon_modifier_rst():
+    """Generate reStructuredText for task icon modifier shortcuts
+    of assorted sizes.
+
+    Makes available `|task-<modifier>-<size>|` where
+      * sizes are
+        * "large"
+        * "super" (superscript)
+        * empty (default size)
+      * Modifiers are defined by files in /img/task-job-icons/task-is*.png.
+    """
+    rst = []
+    for modifier in Path('img/task-job-icons').glob('task-is*.png'):
+        modifier_name = modifier.stem.replace('task-is', '').lower()
+        for size, height in {'-large': 60, '': 18, '-super': 24}.items():
+            rst.append(
+                f".. |task-{modifier_name}{size}| image:: /{str(modifier)}\n"
+                f"   :height: {height}px\n"
+                f"   :align: middle\n"
+                f"   :alt: {modifier_name} icon"
+            )
+    return '\n\n'.join(rst)
+
+
 # -- General configuration ------------------------------------------------
 
 # Sphinx extension module names.
@@ -63,7 +88,8 @@
 rst_prolog = f"""
 .. |reserved_filenames| replace:: ``{'``, ``'.join(WorkflowFiles.RESERVED_NAMES)}``
 """
-rst_epilog = open('hyperlinks.rst.include', 'r').read()
+
+rst_epilog = open('hyperlinks.rst.include', 'r').read() + generate_task_icon_modifier_rst()
 
 default_role = 'cylc:conf'
 
@@ -300,3 +326,5 @@
 # Create sentence case versions of wordlist:
 sentence_case = [word.capitalize() for word in words]
 sentence_case_file.write_text('\n'.join(sentence_case) + '\n')
+
+

src/hyperlinks.rst.include

@@ -72,37 +72,6 @@
    :height: 18px
    :align: middle
 
-
-.. Task Modifiers (inline)
-
-.. |task-held| image:: /img/task-job-icons/task-isHeld.png
-   :height: 18px
-   :align: middle
-
-.. |task-runahead| image:: /img/task-job-icons/task-isRunahead.png
-   :height: 18px
-   :align: middle
-
-.. |task-queued| image:: /img/task-job-icons/task-isQueued.png
-   :height: 18px
-   :align: middle
-
-
-.. Task Modifiers (inline with modifiers as superscript)
-
-.. |task-held-super| image:: /img/task-job-icons/task-isHeld.png
-   :height: 24px
-   :align: middle
-
-.. |task-runahead-super| image:: /img/task-job-icons/task-isRunahead.png
-   :height: 24px
-   :align: middle
-
-.. |task-queued-super| image:: /img/task-job-icons/task-isQueued.png
-   :height: 24px
-   :align: middle
-
-
 .. Job Icons (inline)
 
 .. |job-submitted| image:: /img/task-job-icons/job-submitted.png

src/img/info-view.xtriggers.png

@@ -36,6 +36,21 @@ Cylc 8.5
    :cylc-rose: `1.5 <https://github.com/cylc/cylc-rose/blob/master/CHANGES.md>`__
    :rose: `2.4 <https://github.com/metomi/rose/blob/master/CHANGES.md>`__
 
+More task information in the GUI (and Tui)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Task now icons in the GUI and TUI have badges for tasks waiting for:
+
+* retries |task-retry|
+* xtriggers |task-xtriggered|
+* wallclock |task-wallclock|
+
+Xtriggers, wallclock triggers, retry triggers and task run mode are now
+shown in the information view:
+
+.. image:: ../img/info-view.xtriggers.png
+   :align: center
+   :width: 65%
 
 Compatibility Mode
 ^^^^^^^^^^^^^^^^^^