user-guide: add interventions section

* Closes #626 * Attempt to document the most common operator interventions. * Add the sphinx-design library to the docs environment for tabbed selectors.
cylc · Apr 26, 2024 · f496efe · f496efe
1 parent 3269897
commit f496efe
Show file tree

Hide file tree

Showing 15 changed files with 436 additions and 0 deletions.
diff --git a/setup.cfg b/setup.cfg
@@ -52,6 +52,7 @@ install_requires =
     hieroglyph>=2.1.0
     setuptools>=50
     sphinx>=7.1
+    sphinx-design>=0.5.0
     sphinx_rtd_theme>=1.0.0
     sphinxcontrib-svg2pdfconverter
     sphinxcontrib-spelling

diff --git a/src/conf.py b/src/conf.py
@@ -43,6 +43,7 @@
     # sphinx user community extensions
     'hieroglyph',
     'sphinx_rtd_theme',
+    'sphinx_design',
     # custom project extensions (located in ext/)
     'autodoc_traits',  # autodoc uiserver traitlets
     'database_diagram',

diff --git a/src/user-guide/index.rst b/src/user-guide/index.rst
@@ -9,6 +9,7 @@ User Guide
 
    introduction
    examples/index
+   interventions/index
    writing-workflows/index
    installing-workflows
    running-workflows/index

diff --git a/src/user-guide/interventions/edit-a-tasks-configuration.gui.gif b/src/user-guide/interventions/edit-a-tasks-configuration.gui.gif
diff --git a/src/user-guide/interventions/edit-the-workflow-configuration.tui.gif b/src/user-guide/interventions/edit-the-workflow-configuration.tui.gif