👌 IMPROVE: Workflows - Work chains module (#362)

Make several small changes in language and format to the first half of the
work chain module in the "Workflows" section.

Also add some exercises after the participants have run their first work
chain.

The PR also adds some new MyST substitutions for icons used by the margin
information, and fixes the regex for the `sphinx-copybutton`.

docs/conf.py

@@ -58,14 +58,20 @@
     # "linkify",
     # "replacements",
     # "smartquotes",
-    # "substitution",
+    "substitution",
     # "tasklist",
 ]
 
+myst_substitutions = {
+    "download": '<img src="../../_static/download.png" height="15">',
+    "python": '<img src="../../_static/python.png" height="15">',
+    "aiida": '<img src="../../_static/aiida_logo.png" height="15">',
+}
+
 ipython_mplbackend = ""
 
 copybutton_selector = "div:not(.no-copy)>div.highlight pre"
-copybutton_prompt_text = ">>> |\\\\$ |In \\\\[\\\\d+\\\\]: |\\\\s+\\.\\.\\.: "
+copybutton_prompt_text = ">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
 copybutton_prompt_is_regexp = True
 
 todo_include_todos = True

docs/prolog.inc

@@ -7,6 +7,14 @@
 .. |time| image:: /_static/time.png
     :width: 15px
 
+.. # Define a Python icon
+.. |python| image:: /_static/python.png
+    :width: 15px
+
+.. # Define an AiiDA icon
+.. |aiida| image:: /_static/aiida_logo.png
+    :width: 15px
+
 .. # define level colors
 .. role:: aiida-green
 .. role:: aiida-blue

docs/sections/workflows/include/code/new_scripts/my_first_workchain_1_output_input.py

@@ -3,7 +3,7 @@
 
 
 class OutputInputWorkChain(WorkChain):
-    """WorkChain to output the input."""
+    """Toy WorkChain that simply passes the input as an output."""
 
     @classmethod
     def define(cls, spec):
@@ -15,7 +15,7 @@ def define(cls, spec):
         spec.output("workchain_result", valid_type=Int)
 
     def result(self):
-        """Parse the result."""
+        """Pass the input as an output."""
 
         # Declaring the output
         self.out("workchain_result", self.inputs.x)

docs/sections/workflows/index.rst

@@ -31,7 +31,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 20 min
-          - :aiida-green:`Basic`
+          - |aiida| :aiida-green:`Basic`
 
 .. panels::
     :header: panel-header-text
@@ -57,7 +57,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 60 min
-          - :aiida-green:`Basic`
+          - |aiida| :aiida-green:`Basic`
 
 .. panels::
     :header: panel-header-text
@@ -82,7 +82,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 30 min
-          - :aiida-blue:`Intermediate`
+          - |aiida| :aiida-blue:`Intermediate`
 
     ------
     :column: col-lg-6
@@ -102,7 +102,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 30 min
-          - :aiida-blue:`Intermediate`
+          - |aiida| :aiida-blue:`Intermediate`
 
 .. panels::
     :header: panel-header-text
@@ -127,7 +127,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 20 min
-          - :aiida-blue:`Intermediate`
+          - |aiida| :aiida-blue:`Intermediate`
 
     ------
     :column: col-lg-6
@@ -147,7 +147,7 @@ Workflows
         :header-rows: 0
 
         * - |time| 30 min
-          - :aiida-orange:`Advanced`
+          - |aiida| :aiida-orange:`Advanced`
 
 .. toctree::
     :hidden: